Skip to content

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

Merged
pawelru merged 1 commit into
mainfrom
fix_verdepcheck
Apr 8, 2024
Merged

docs: vignettes: add purl=FALSE to the chunk producing error#307
pawelru merged 1 commit into
mainfrom
fix_verdepcheck

Conversation

@pawelru

@pawelru pawelru commented Apr 8, 2024

Copy link
Copy Markdown
Contributor

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

@pawelru pawelru added the core label Apr 8, 2024
@pawelru
pawelru enabled auto-merge (squash) April 8, 2024 11:05
@github-actions

github-actions Bot commented Apr 8, 2024

Copy link
Copy Markdown
Contributor

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: dce28b6

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@github-actions

github-actions Bot commented Apr 8, 2024

Copy link
Copy Markdown
Contributor

Unit Tests Summary

  1 files   14 suites   2s ⏱️
193 tests 191 ✅ 2 💤 0 ❌
265 runs  263 ✅ 2 💤 0 ❌

Results for commit dce28b6.

@pawelru

pawelru commented Apr 8, 2024

Copy link
Copy Markdown
Contributor Author

@kartikeyakirar kartikeyakirar self-assigned this Apr 8, 2024

@kartikeyakirar kartikeyakirar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

@pawelru
pawelru merged commit 01a6ca8 into main Apr 8, 2024
@pawelru
pawelru deleted the fix_verdepcheck branch April 8, 2024 15:08
averissimo added a commit that referenced this pull request Jun 12, 2025
…l_data` (#370)

# Pull Request

Fixes:

- insightsengineering/teal#1526

Built on top of:

- insightsengineering/teal.reporter#307
    - _(#307 will be closed once this PR is stable)_

### Companion PRs:

- insightsengineering/teal#1541
- insightsengineering/teal.code#255
- #370
- insightsengineering/teal.reporter#331
- insightsengineering/teal.modules.general#884

### Changes description

- [x] Cleanup of `teal_data` class to allow for `teal_report` extension
- [x] Change the `show()` method to remove reference to `teal_data`
specifically

---------

Co-authored-by: Dawid Kaledkowski <dawid.kaledkowski@gmail.com>
Co-authored-by: Marcin <133694481+m7pr@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants