Replace TealData with teal_data in the docs #845
Conversation
| #' cdisc_dataset("ADSL", adsl), | ||
| #' cdisc_dataset("ADQS", adqs) |
There was a problem hiding this comment.
I know this was not the case before, But I think we should make the teal_data object reproducible so that the code in the Show R code works. Right now it won't work because the data creation code is not specified.
@kartikeyakirar what do you think about adding it for all the examples so they are improved?
There was a problem hiding this comment.
I think its good idea. However, considering that these are for example for TMC modules and the preprocessing code be lengthy in some cases, which in turn might elongate the 'cdisc_data' call, I would lean towards not including it in for all the examples.
@gogonzo @donyunardi WDYT?
There was a problem hiding this comment.
I think there is no need to specify the code anymore, we have the new within() function. I think we need to document it as I believe it's the best practice.
There was a problem hiding this comment.
There are very few examples like that, and it's included in most of the tmg examples. I will make the update.
There was a problem hiding this comment.
@vedhav I think this qualifies to another issue. @kartikeyakirar feel free to make code reproducible or keep as reproducible as it was before. We need this soon on @main so I advise to make this branch ready as quick as possible.
|
should we bump |
| @@ -68,7 +68,7 @@ Suggests: | |||
| knitr, | |||
| lubridate, | |||
| nestcolor (>= 0.1.0), | |||
| teal.data (>= 0.3.0), | |||
| teal.data (>= 0.3.0.9008), | |||
There was a problem hiding this comment.
Usually, I guess we only work after the changes are merged into main and get the proper version. But, since in this case, we're working on top of unmerged changes the version will be higher than this. If everything goes well and we merge join_keys PR first it will be 0.3.0.9009 so I saw we wait for the version bump till the teal.data join_keys PR is merged.
There was a problem hiding this comment.
YEs, once join_keys PR is merged. will make consistent version bump to all the replace doc PR for teal.data
There was a problem hiding this comment.
I have the same in teal.modules.hermes https://github.com/insightsengineering/teal.modules.hermes/pull/342/files#r1386573062
|
closing in favour of #847 |
fixes #842
part of
insightsengineering/nestdevs-tasks#41
insightsengineering/teal.data#184
JoinKeysfrom R6 to S3 list-like object teal.data#184.JoinKeysfrom R6 to S3 list-like object teal.data#184. is merged.