Introduce teal_data class - #171
Conversation
Co-authored-by: dinakar29 <26552821+dinakar29@users.noreply.github.com>
* the code related to `teal`'s data models moved from the original teal and teal.devel packages Related to insightsengineering/coredev-tasks#130
* fix vignette Co-authored-by: Dawid Kałędkowski <dawid.kaledkowski@gmail.com>
* refactored `is` to `inherits` * did some styling changes - someone really loved new lines when writing these tests Closes #11
* is to inherits
* update staged.deps * add tmh to downstream * Apply suggestions from code review * to_relational_data.TealData - to return TealData * Update R/to_relational_data.R Co-authored-by: Dawid Kałędkowski <dawid.kaledkowski@gmail.com>
* removed var_relabel * removed variable_labels and updated staged.dependencies * importFrom formatable var_labels * docs * removed extra space
* rename formatable into formatters * actions
| #' @name new_teal_data | ||
| #' | ||
| #' @param code (`character(1)` or `language`) code to evaluate. Accepts and stores comments also. | ||
| #' @param env (`list`) List of data. |
There was a problem hiding this comment.
Unless I am mistaken, we intend to always pass a list of datasets to this argument. The argument name is misleading then. Yes, the datasets will be list2env'ed and end up in the @env slot but it is not an environment that we pass. Can we name this more appropriately?
There was a problem hiding this comment.
True, at this moment we have:
new_qenv(env = "environment", code = c("character", "language"))
new_teal_data(env = "list", code = c("character", "language"))
teal/cdisc_data(..., code = c("character", "language"))According to our discussion two days ago, we plan to remove possibility to add env and code in new_qenv (we need to soft deprecate this). In the new_teal_data, i would change argument env to data (a list).
new_qenv()
new_teal_data(env = "??", code = c("character", "language"))
teal/cdisc_data(..., code = c("character", "language"))following changes in teal.code
fix
There was a problem hiding this comment.
What is the convention on @main to signal minor version bump? Should I set version from 0.3.0.9xxx 0.3.9.9xxx?
There was a problem hiding this comment.
Set it to the target 0.4.0 value and merge the whole PR with [skip vbump]
@cicdguy please confirm
There was a problem hiding this comment.
Correct. Bump to 0.4.0 for minor version.
The first digit is for major breaking changes.
The second for minor changes like features which do not break the core API.
The third digit is for patches and bugfixes.
So unless you're making a new release out of this, I'd say the new version is just a development version.
There was a problem hiding this comment.
Can we do it now or shall we wait for the pre-release clean-ups? I think the latter as there might be other PRs merged in afterwards which will make it 0.4.0.9xxx and from there it would be problematic to "downgrade" into the target 0.4.0. So essentially we can address it during pre-release clean-up. Is that right?
There was a problem hiding this comment.
Yes I would prefer doing it here instead of doing it later and downgrading it.
There was a problem hiding this comment.
Sorry I wasn't clear. It is either:
- do it now -> expect upcoming vbumps during standard dev cycle or hot-fixes -> downgrade during pre-release clean-ups
- wait and do it later during pre-release clean-ups
There was a problem hiding this comment.
Just clarified this - yes let's wait and do it later during pre-release cleanups (aka when the PR is being prepared for an upcoming release).
|
Please hold on merging this to |
- Config/Needs/verdepcheck entries in new line - add `bioc::` for packages from Bioconductor Signed-off-by: Pawel Rucki <12943682+pawelru@users.noreply.github.com>
need higher version of teal.code - code slot is a character
update pkgdown
|
By accident I've closed this PR without a change to open again. New PR here #178 |
Part of insightsengineering/teal#937
Other PRs insightsengineering/teal#925 insightsengineering/teal.slice#440 insightsengineering/teal.gallery#75 insightsengineering/teal.code#153
install
teal_data class
teal_dataclass (teal_data-class.R) is en extension ofqenv.teal_datacontains extra slotsdatanamesandjoin_keys. Besides, allteal.codemethods works withteal_dataobject (eval_code, print etc.)TealData$serverreturnsteal_datanow - to have single object type in teal (not inteal_module)cdisc_data()andteal_data()returnTealDataorteal_data