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.

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

basic chunks vignette #21

Merged
merged 17 commits into from
Apr 28, 2022
Merged

basic chunks vignette #21

merged 17 commits into from
Apr 28, 2022

Conversation

mhallal1
Copy link
Contributor

closes #2
The Basic chunks is divided into 2 parts:

  1. Get started vignette: Reproducibility, reproducibility in teal and chunks as a concept.
  2. Basic chunks vignette: Definition of chunks, methods, step-by-step to understand the sequence of using chunks, implicit vs explicit usage

The advanced vignette #1 will host the chunks in shiny app, chunks in teal app and chunks tricks.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 25, 2022

Code Coverage Summary

Filename                Stmts    Miss  Cover    Missing
--------------------  -------  ------  -------  ----------------------------------------------------------------------------------------------------------------------------------------
R/chunk.R                 150       3  98.00%   363-369
R/chunks_pipe.R            28      25  10.71%   16-48
R/chunks.R                401      40  90.02%   330, 420, 426-429, 435, 462-463, 480-487, 496, 502-511, 557, 583, 589-590, 592, 608, 617, 626, 668, 671, 694-699, 1025, 1046, 1100, 1151
R/get_eval_details.R      113     113  0.00%    15-178
R/include_css_js.R          7       7  0.00%    12-19
R/utils.R                  24      19  20.83%   13, 17-38
TOTAL                     723     207  71.37%

Results for commit: 96a65bb

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@nikolas-burkoff nikolas-burkoff self-assigned this Apr 25, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 25, 2022

Unit Tests Summary

    1 files      2 suites   2s ⏱️
  39 tests   39 ✔️ 0 💤 0
289 runs  289 ✔️ 0 💤 0

Results for commit dadf854.

♻️ This comment has been updated with latest results.

Copy link
Contributor

@nikolas-burkoff nikolas-burkoff left a comment

Choose a reason for hiding this comment

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

I've put some initial comments in, I'll take another look when you let me know you're happy.

I might have created a small app explicitly creating chunks as well as I think that aids explanation but up to you

vignettes/teal-code.Rmd Outdated Show resolved Hide resolved
vignettes/teal-code.Rmd Outdated Show resolved Hide resolved
vignettes/teal-code.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
@arkadiuszbeer
Copy link
Contributor

To be consistent, change the name of vignettes/images/get_rcode.PNG file to vignettes/images/get_rcode.png

@arkadiuszbeer
Copy link
Contributor

gitleak/PII check will pass after this merge insightsengineering/r.pkg.template#79

@mhallal1
Copy link
Contributor Author

To be consistent, change the name of vignettes/images/get_rcode.PNG file to vignettes/images/get_rcode.png

@arkadiuszbeer done.

inst/WORDLIST Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
Copy link
Contributor

@nikolas-burkoff nikolas-burkoff left a comment

Choose a reason for hiding this comment

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

Nearly there now (the docs are in much much better shape than they were)

  • Do we need a PR in agile-R removing the articles and just pointing to these vignettes?
  • I think these vignettes along with the basic module example should give people a good basic understanding of chunks

vignettes/teal-code.Rmd Outdated Show resolved Hide resolved
vignettes/teal-code.Rmd Outdated Show resolved Hide resolved
vignettes/teal-code.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
vignettes/basic_chunks.Rmd Outdated Show resolved Hide resolved
Copy link
Contributor

@nikolas-burkoff nikolas-burkoff left a comment

Choose a reason for hiding this comment

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

Yup this looks good 👍

@mhallal1 mhallal1 merged commit 1d8daf6 into main Apr 28, 2022
@mhallal1 mhallal1 deleted the 2_basic_chunks@main branch April 28, 2022 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reproducibility - Chunks vignette (basics)
3 participants