Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

datanames in vignettes #357

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

datanames in vignettes #357

wants to merge 3 commits into from

Conversation

gogonzo
Copy link
Contributor

@gogonzo gogonzo commented Dec 18, 2024

see insightsengineering/teal.code#239

Refers to #338

Modified a documentation a little bit to emphasize inheritance from environment.

@gogonzo gogonzo added the core label Dec 18, 2024
@averissimo averissimo self-assigned this Dec 18, 2024
@gogonzo gogonzo changed the title teal_data characteristics datanames in vignettes Dec 18, 2024
m7pr
m7pr reviewed Dec 18, 2024
View reviewed changes
R/teal_data-constructor.R Outdated Show resolved Hide resolved
m7pr
m7pr reviewed Dec 18, 2024
View reviewed changes
R/teal_data-constructor.R Outdated Show resolved Hide resolved
m7pr
m7pr reviewed Dec 18, 2024
View reviewed changes
R/teal_data-constructor.R Outdated
Comment on lines 31 to 32
#' - It stores metadata about the code used to create the data.
#' - It maintains information about relationships between datasets.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe let's get a bit into some details? But that would require describing the fields

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see we deleted those details in the vignette

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a links to the functions responsible for these topics

m7pr
m7pr reviewed Dec 18, 2024
View reviewed changes
vignettes/teal-data.Rmd Outdated Show resolved Hide resolved
llrs-roche
llrs-roche reviewed Dec 18, 2024
View reviewed changes
Copy link
Contributor

@llrs-roche llrs-roche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking forward to the other updates.

R/teal_data-constructor.R Outdated Show resolved Hide resolved
vignettes/teal-data.Rmd Outdated Show resolved Hide resolved
R/teal_data-constructor.R Outdated Show resolved Hide resolved
R/teal_data-constructor.R Outdated Show resolved Hide resolved
vignettes/teal-data.Rmd Outdated Show resolved Hide resolved
@gogonzo gogonzo marked this pull request as ready for review December 19, 2024 13:05
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 19, 2024 •
edited
Loading

badge

Code Coverage Summary

Filename                     Stmts    Miss  Cover    Missing
-------------------------  -------  ------  -------  -------------------
R/cdisc_data.R                   1       0  100.00%
R/deprecated.R                  14       0  100.00%
R/dummy_function.R               2       2  0.00%    14-15
R/formatters_var_labels.R       61       0  100.00%
R/join_key.R                    38       0  100.00%
R/join_keys-c.R                 12       0  100.00%
R/join_keys-extract.R          128       0  100.00%
R/join_keys-names.R             15       0  100.00%
R/join_keys-parents.R           30       0  100.00%
R/join_keys-print.R             45       0  100.00%
R/join_keys-utils.R             73       3  95.89%   35-38
R/join_keys.R                   21       0  100.00%
R/teal_data-class.R             37       3  91.89%   64, 111-112
R/teal_data-constructor.R       11       2  81.82%   49, 53
R/teal_data-extract.R            3       0  100.00%
R/teal_data-get_code.R          13       8  38.46%   114-120, 124
R/teal_data-names.R              8       1  87.50%   31
R/teal_data-show.R               5       5  0.00%    14-20
R/testhat-helpers.R             26       0  100.00%
R/topological_sort.R            32       0  100.00%
R/verify.R                      42      11  73.81%   67, 97-101, 104-108
TOTAL                          617      35  94.33%

Diff against main

Filename              Stmts    Miss  Cover
------------------  -------  ------  --------
R/teal_data-show.R       +1      +1  +100.00%
TOTAL                    +1      +1  -0.15%

Results for commit: b26fe19

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@github-actions GitHub Actions
Copy link
Contributor

Unit Tests Summary

  1 files   15 suites   2s ⏱️
163 tests 151 ✅ 12 💤 0 ❌
213 runs  201 ✅ 12 💤 0 ❌

Results for commit 671cd48.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 19, 2024 •
edited
Loading

Unit Tests Summary

  1 files   15 suites   1s ⏱️
163 tests 151 ✅ 12 💤 0 ❌
213 runs  201 ✅ 12 💤 0 ❌

Results for commit b26fe19.

♻️ This comment has been updated with latest results.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@llrs-roche llrs-roche llrs-roche left review comments

@m7pr m7pr m7pr left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@averissimo averissimo

Labels
core
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@gogonzo @m7pr @llrs-roche @averissimo