insightsengineering / teal.data

Data model for teal applications
https://insightsengineering.github.io/teal.data/
Other
8 stars 7 forks source link

docs: vignettes: add `purl=FALSE` to the chunk producing error #307

Closed pawelru closed 5 months ago

pawelru commented 5 months ago

fix verdepcheck errors: https://github.com/insightsengineering/teal.data/actions/runs/8585969509/job/23527932989

this currently fails with the below:

* checking running R code from vignettes ...
  ‘join-keys.Rmd’ using ‘UTF-8’... OK
  ‘teal-data-reproducibility.Rmd’ using ‘UTF-8’... failed
  ‘teal-data.Rmd’ using ‘UTF-8’... OK
 ERROR
Errors in running code in vignettes:
when running code in ‘teal-data-reproducibility.Rmd’
  ...
+     data <- data.frame(x = 11:20)
+ }))
> verify(data_wrong)
  When sourcing ‘teal-data-reproducibility.R’:
Error: Code verification failed.
Object(s) recreated with code that have different structure in data_wrong:
  • data
Execution halted

This is also present if you just run rcmdcheck::rcmdcheck() (i.e. without verdepcheck).

Follow the guidelines from here

If you want to deliberately execute errors (to show the user what failure looks like), make sure the chunk has error = TRUE, purl = FALSE.

I will be running the pipeline manually. You can track its status here: https://github.com/insightsengineering/teal.data/actions/workflows/scheduled.yaml?query=branch%3Afix_verdepcheck

github-actions[bot] commented 5 months ago

badge

Code Coverage Summary

Filename                         Stmts    Miss  Cover    Missing
-----------------------------  -------  ------  -------  --------------------
R/cdisc_data.R                       1       0  100.00%
R/deprecated.R                      57      57  0.00%    19-344
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                 25       1  96.00%   69
R/teal_data-datanames.R             10       0  100.00%
R/teal_data-get_code.R              14       0  100.00%
R/teal_data-show.R                   4       4  0.00%    14-19
R/teal_data.R                       30      16  46.67%   33, 36-42, 52-58, 61
R/testhat-helpers.R                 26       0  100.00%
R/topological_sort.R                32       0  100.00%
R/utils-get_code_dependency.R      184       1  99.46%   275
R/verify.R                          42      11  73.81%   65, 95-99, 102-106
TOTAL                              850      95  88.82%

Diff against main

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

Results for commit: dce28b6441c32b33edea02b99e190299683d34ef

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

github-actions[bot] commented 5 months ago

Unit Tests Summary

  1 files   14 suites   2s :stopwatch: 193 tests 191 :white_check_mark: 2 :zzz: 0 :x: 265 runs  263 :white_check_mark: 2 :zzz: 0 :x:

Results for commit dce28b64.

pawelru commented 5 months ago

All is green: https://github.com/insightsengineering/teal.data/actions/runs/8600286425 I'm enabling auto-merge.