Skip to content

Organise vignettes in sections #165

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
Merged
averissimo merged 12 commits into from
Sep 12, 2023
Merged

Organise vignettes in sections #165

averissimo merged 12 commits into from
Sep 12, 2023

Conversation

@averissimo
Copy link
Contributor

@averissimo averissimo commented Sep 12, 2023

Pull Request

Related to:

Changes description

  • Creates 3 sections:
    • Getting started
    • Delayed data loading
    • Other dataset connectors

@averissimo
Copy link
Contributor Author

averissimo commented Sep 12, 2023 •
edited
Loading

First jab at it, feel free to provide feedback and ideas

Question:

  • Should the delayed data loading section include the Acronym ... (DDL) or connector ... (dataset connector)?

image

@github-actions
Copy link
Contributor

github-actions bot commented Sep 12, 2023 •
edited
Loading

badge

Code Coverage Summary

Filename                                 Stmts    Miss  Cover    Missing
-------------------------------------  -------  ------  -------  -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
R/as_cdisc.R                                39       4  89.74%   99-102
R/Callable.R                                45       0  100.00%
R/CallableCode.R                            36       2  94.44%   26, 63
R/CallableFunction.R                        88       3  96.59%   160-162
R/CallablePythonCode.R                      58      58  0.00%    21-227
R/cdisc_data.R                              45       1  97.78%   76
R/CDISCTealDataConnector.R                  20       3  85.00%   31, 36, 49
R/CDISCTealDataset.R                        46      11  76.09%   108-115, 204-206
R/CDISCTealDatasetConnector.R               26       1  96.15%   116
R/CodeClass.R                              111       1  99.10%   157
R/data_label.R                              36      13  63.89%   33-37, 56-63, 103
R/deep_clone_r6.R                            9       0  100.00%
R/dummy_function.R                           5       1  80.00%   23
R/formatters_var_labels.R                   49      21  57.14%   30, 38, 43-44, 46, 53, 99, 129-151
R/get_attrs.R                                2       2  0.00%    12-45
R/get_code.R                               173      19  89.02%   87, 140-143, 196-197, 207-208, 266, 297, 333, 337, 372, 381-385
R/get_dataname.R                             4       0  100.00%
R/get_dataset_label.R                        3       0  100.00%
R/get_dataset.R                             13       8  38.46%   39, 55, 80-86
R/get_datasets.R                            10       2  80.00%   96, 116
R/get_key_duplicates.R                      37       7  81.08%   41-47, 54-55
R/get_keys.R                                15       7  53.33%   67-68, 125-145
R/get_raw_data.R                            24      11  54.17%   168-181
R/include_css_js.R                           9       1  88.89%   20
R/is_pulled.R                                4       0  100.00%
R/JoinKeys.R                               183       7  96.17%   134, 233, 327, 330, 388-425
R/load_dataset.R                            25      18  28.00%   58-63, 87-186
R/MAETealDataset.R                         138      57  58.70%   53, 115, 153-208, 224-229, 236-245, 282, 323-339
R/mutate_dataset.R                          18       0  100.00%
R/set_args.R                                10       5  50.00%   34-38
R/teal_data.R                               31       2  93.55%   44, 52
R/TealData.R                               228     113  50.44%   206, 218-287, 330-337, 370-375, 377, 379-384, 386, 403-448
R/TealDataAbstract.R                       232      24  89.66%   72, 85-88, 97-106, 215-218, 429, 454-458, 480, 486
R/TealDataConnection.R                     297     180  39.39%   58-59, 64, 67, 70, 106-163, 183, 186-188, 194-200, 205-207, 233, 238, 254-277, 287, 300, 321, 325-330, 333-336, 358-360, 364-371, 374-377, 392-406, 425-426, 446-517, 535-543, 545, 549-564, 567-570, 602, 608-612, 626, 661-663, 672-674
R/TealDataConnector.R                      196     102  47.96%   178, 190, 194, 207, 210-219, 221, 229-238, 321-325, 383-488
R/TealDataset.R                            367      23  93.73%   141-151, 382-386, 442-451, 503
R/TealDatasetConnector_constructors.R      270      52  80.74%   177-214, 727-732, 930-1006
R/TealDatasetConnector.R                   326      90  72.39%   169, 237, 251, 256, 270, 433, 456-495, 525, 540-570, 660, 670, 679-686, 699, 714-741
R/to_relational_data.R                      54       7  87.04%   35-36, 40, 99, 106, 112, 127
R/topological_sort.R                        32       0  100.00%
R/utils.R                                   56       9  83.93%   22-23, 27, 76-83
R/validate_data_args.R                      32       0  100.00%
R/zzz.R                                      6       6  0.00%    4-12
TOTAL                                     3408     871  74.44%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 913f0de

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@github-actions
Copy link
Contributor

github-actions bot commented Sep 12, 2023 •
edited
Loading

Unit Tests Summary

       1 files       27 suites   17s ⏱️
   365 tests    365 ✔️ 0 💤 0 ❌
1 010 runs  1 010 ✔️ 0 💤 0 ❌

Results for commit 5720dc0.

♻️ This comment has been updated with latest results.

@averissimo averissimo marked this pull request as draft September 12, 2023 11:45
@averissimo averissimo marked this pull request as ready for review September 12, 2023 13:15
averissimo
averissimo commented Sep 12, 2023
View reviewed changes
vignettes/teal-data.Rmd
Comment on lines +51 to +56
- [Specifying relationships between your datasets](join-keys.html)
- [Dynamically loading your data (`DDL`)](using-delayed-data-basic.html)
- [Pre-processing data](preprocessing-data.html)
- [Pre-processing `DDL` data ](preprocessing-delayed-data.html)
- [Checking for reproducibility](reproducibility.html)
- [Using python to create your data](teal.data-with-python.html)
Copy link
Contributor Author

@averissimo averissimo Sep 12, 2023

Choose a reason for hiding this comment

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

@m7pr This will create a merge conflict with #166

WDYT about using relative links instead?

Copy link
Contributor

@m7pr m7pr Sep 12, 2023

Choose a reason for hiding this comment

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

@averissimo I think relative are better in here honestly

m7pr
m7pr approved these changes Sep 12, 2023
View reviewed changes
Copy link
Contributor

@m7pr m7pr left a comment

Choose a reason for hiding this comment

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

Great work @averissimo

@averissimo averissimo merged commit 05880c2 into main Sep 12, 2023
@averissimo averissimo deleted the 468_group_vigneetes@main branch September 12, 2023 16:56
@m7pr
Copy link
Contributor

m7pr commented Sep 13, 2023

Hey @averissimo can I have one more favour? Would you be able to delete dates from vignettes?
See this comment insightsengineering/teal.logger#55 (comment)

@averissimo
Copy link
Contributor Author

averissimo commented Sep 13, 2023

Yes @m7pr will do for teal.data!

❓❔ Do you need help doing that for any other package?

@averissimo
Copy link
Contributor Author

averissimo commented Sep 13, 2023

@m7pr it seems like you already did it as part of the readme updates c0ab07d

@m7pr
Copy link
Contributor

m7pr commented Sep 13, 2023 via email

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

Reviewers

@m7pr m7pr m7pr approved these changes

Assignees

No one assigned

Labels

core

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@averissimo @m7pr