Adds `names()` function and deprecates `datanames()` #347

averissimo · 2024-10-28T13:44:31Z

Pull Request

Fixes [Feature Request]: Don't use @datanames anymore #333
Companion of Change qenv as environment "type" -- adds names(qenv/qenv.error), get() and $ S3 methods teal.code#218

Blockers

{teal.code}
- Merge Change qenv as environment "type" -- adds names(qenv/qenv.error), get() and $ S3 methods teal.code#218

Changes description

R/deprecated.R

R/teal_data-names.R

…objects

github-actions · 2024-11-05T18:49:24Z

Code Coverage Summary

Filename                     Stmts    Miss  Cover    Missing
-------------------------  -------  ------  -------  --------------------
R/cdisc_data.R                   1       0  100.00%
R/deprecated.R                  71      65  8.45%    19-380
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             14       0  100.00%
R/teal_data-get_code.R          13       8  38.46%   114-120, 124
R/teal_data-names.R              8       1  87.50%   31
R/teal_data-show.R               4       4  0.00%    14-19
R/teal_data.R                   31      16  48.39%   33, 36-42, 52-58, 61
R/testhat-helpers.R             26       0  100.00%
R/topological_sort.R            32       0  100.00%
R/verify.R                      42      11  73.81%   67, 97-101, 104-108
TOTAL                          667     110  83.51%

Diff against main

Filename               Stmts    Miss  Cover
-------------------  -------  ------  --------
R/deprecated.R           +14      +8  +8.45%
R/join_keys.R             -1       0  +100.00%
R/teal_data-class.R      -12      -1  +3.85%
R/teal_data-names.R       +8      +1  +87.50%
R/teal_data.R             +1       0  +1.72%
TOTAL                    +10      +8  -1.43%

Results for commit: 04fd26e

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

github-actions · 2024-11-05T18:49:53Z

Unit Tests Summary

1 files 13 suites 1s ⏱️
158 tests 158 ✅ 0 💤 0 ❌
213 runs 213 ✅ 0 💤 0 ❌

Results for commit 33de31f.

github-actions · 2024-11-05T18:49:54Z

Unit Tests Summary

1 files 13 suites 1s ⏱️
158 tests 158 ✅ 0 💤 0 ❌
213 runs 213 ✅ 0 💤 0 ❌

Results for commit 04fd26e.

♻️ This comment has been updated with latest results.

github-actions · 2024-11-05T18:49:56Z

Unit Test Performance Difference

Test Suite	$Status$	Time on `main`	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
datanames	💀	$0.17$	$-0.17$	$-17$	$0$	$0$	$0$
test_data-names	👶		$+0.13$	$+12$	$0$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on `main`	$±Time$	Test Case
datanames	💀	$0.00$	$-0.00$	datanames_are_set_in_topological_order_in_constructor_if_join_keys_are_specified
datanames	💀	$0.00$	$-0.00$	datanames_called_on_qenv.error_does_not_change_qenv.error
datanames	💀	$0.00$	$-0.00$	datanames_called_on_qenv.error_returns_NULL
datanames	💀	$0.01$	$-0.01$	datanames_can_set_value_of_datanames
datanames	💀	$0.00$	$-0.00$	datanames_do_not_return_parent_if_in_constructor_it_was_provided_in_join_keys_but_do_not_exists_in_env
datanames	💀	$0.00$	$-0.00$	datanames_do_not_return_parent_if_join_keys_were_provided_and_parent_did_not_exists_in_env
datanames	💀	$0.00$	$-0.00$	datanames_return_parent_if_in_constructor_it_was_provided_in_join_keys_and_exists_in_env
datanames	💀	$0.01$	$-0.01$	datanames_return_parent_if_join_keys_were_provided_and_parent_exists_in_env
datanames	💀	$0.01$	$-0.01$	datanames_return_topological_order_of_datasets_after_datanames_are_called_after_join_keys
datanames	💀	$0.01$	$-0.01$	datanames_return_topological_order_of_datasets_once_join_keys_are_specified
datanames	💀	$0.02$	$-0.02$	datanames_returns_contents_of_datanames_slot
datanames	💀	$0.01$	$-0.01$	datanames_supports_qenv.error_class
datanames	💀	$0.08$	$-0.08$	only_names_of_existing_variables_are_accepted
datanames	💀	$0.00$	$-0.00$	variables_not_in_datanames_are_omitted
teal_data	👶		$+0.02$	teal_data_.xData_is_locked._Not_able_to_modify_add_or_remove_bindings
teal_data	💀	$0.02$	$-0.02$	teal_data_env_is_locked._Not_able_to_modify_add_or_remove_bindings
teal_data	💀	$0.01$	$-0.01$	teal_data_initializes_teal_data_object_with_datanames_taken_from_passed_objects
teal_data	💀	$0.00$	$-0.00$	teal_data_initializes_teal_data_object_with_datanames_taken_only_from_passed_objects_and_not_join_keys
teal_data	👶		$+0.01$	teal_data_initializes_teal_data_object_with_names_taken_only_from_passed_objects_and_not_join_keys
teal_data	💀	$0.00$	$-0.00$	teal_data_initializes_teal_data_object_without_datanames_taken_from_join_keys_if_objects_did_not_exist_in_env
teal_data	👶		$+0.01$	teal_data_initializes_teal_data_object_without_names_taken_from_join_keys_if_objects_did_not_exist_in_env
test_data-names	👶		$+0.01$	names_are_set_in_topological_order_in_constructor_if_join_keys_are_specified
test_data-names	👶		$+0.04$	names_called_on_teal_data_does_not_change_it
test_data-names	👶		$+0.01$	names_do_not_return_parent_if_in_constructor_it_was_provided_in_join_keys_but_do_not_exists_in_env
test_data-names	👶		$+0.01$	names_do_not_return_parent_if_join_keys_were_provided_and_parent_did_not_exists_in_env
test_data-names	👶		$+0.01$	names_return_parent_if_in_constructor_it_was_provided_in_join_keys_and_exists_in_env
test_data-names	👶		$+0.01$	names_return_parent_if_join_keys_were_provided_and_parent_exists_in_env
test_data-names	👶		$+0.01$	names_return_topological_order_of_datasets_after_new_objects_are_added_after_join_keys
test_data-names	👶		$+0.02$	names_return_topological_order_of_datasets_once_join_keys_are_specified
test_data-names	👶		$+0.01$	names_returns_list_of_objects_in_teal_data
test_data-names	👶		$+0.01$	names_supports_qenv.error_class
test_data-names	👶		$+0.01$	variables_with_dot_prefix_are_omitted

Results for commit 5657be8

♻️ This comment has been updated with latest results.

gogonzo

I exhausted all comments here. Accept with a minor comment which you can address or not 👍

R/teal_data-class.R

.pre-commit-config.yaml

Co-authored-by: Dawid Kałędkowski <[email protected]> Signed-off-by: André Veríssimo <[email protected]>

R/teal_data-class.R

…`, `get()` and `$` S3 methods (#218) # Pull Request - Part of insightsengineering/teal.data#333 - Fixes #221 - closes #164 - Companion of insightsengineering/teal.data#347 #### Changes description - `qenv` S4 class inherits from `environment` data class - Removes `@env` slot in favor of `qenv` - Replace all instances of `@env` with `@.xData` (slot created by parent class) - All functions/methods that work for `environment` class are supported natively in `qenv` --------- Signed-off-by: André Veríssimo <[email protected]> Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com> Co-authored-by: Dawid Kałędkowski <[email protected]> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

feat: initial support for names(teal_data)

eb24644

averissimo added the core label Oct 28, 2024

averissimo mentioned this pull request Oct 28, 2024

Change qenv as environment "type" -- adds names(qenv/qenv.error), get() and $ S3 methods insightsengineering/teal.code#218

Merged

fix: remove extra parameters and deprecate names()<-.teal_data

b3fe731

gogonzo self-assigned this Oct 29, 2024

averissimo added 2 commits October 30, 2024 18:57

feat: update to remove all @env mentions

8406a83

fix: replace @env and corrects minor issues with qenv as environment

cd5a938

gogonzo reviewed Oct 31, 2024

View reviewed changes

R/deprecated.R Show resolved Hide resolved

fix: use names instead of ls

4f92467

averissimo commented Nov 1, 2024

View reviewed changes

R/teal_data-names.R Outdated Show resolved Hide resolved

fix: names return sorted strings and adds github prefix to teal.code

d35fcca

This was referenced Nov 4, 2024

teal.data::datanames() is deprecated in favor of dot-prefix and names() insightsengineering/teal.modules.general#794

Merged

teal.data::datanames() is deprecated in favor of dot-prefix and ls() insightsengineering/teal.transform#226

Merged

averissimo marked this pull request as ready for review November 4, 2024 14:36

averissimo mentioned this pull request Nov 4, 2024

teal.data::datanames() is deprecated in favor of dot-prefix and names() insightsengineering/teal.modules.clinical#1239

Merged

averissimo added 2 commits November 4, 2024 18:21

feat: exclude dot prefixed names from teal.data

711a7e9

fix: pkgdown and adds custom length that only shows non-dot prefixed …

cba8ac7

…objects

averissimo mentioned this pull request Nov 4, 2024

teal.data::datanames() is deprecated in favor of dot-prefix and ls() insightsengineering/teal#1402

Merged

chore: bumps versions

33de31f

This was referenced Nov 5, 2024

teal.data::datanames() is deprecated in favor of dot-prefix and names() insightsengineering/teal.osprey#288

Merged

teal.data::datanames() is deprecated in favor of dot-prefix and names() insightsengineering/teal.goshawk#324

Merged

gogonzo approved these changes Nov 5, 2024

View reviewed changes

R/teal_data-class.R Outdated Show resolved Hide resolved

gogonzo reviewed Nov 5, 2024

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved

averissimo and others added 3 commits November 6, 2024 16:19

Update .pre-commit-config.yaml

64f16da

Co-authored-by: Dawid Kałędkowski <[email protected]> Signed-off-by: André Veríssimo <[email protected]>

feat: move code/id/warn/msg logic to teal.code and simplify

583b145

chore: fix lint error

1c28625

gogonzo reviewed Nov 7, 2024

View reviewed changes

R/teal_data-class.R Show resolved Hide resolved

pr: apply suggestion by @gogonzo

04fd26e

averissimo merged commit 3d899ee into main Nov 8, 2024
29 checks passed

averissimo deleted the 333_deprecate_datanames@main branch November 8, 2024 09:58

github-actions bot locked and limited conversation to collaborators Nov 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds `names()` function and deprecates `datanames()` #347

Adds `names()` function and deprecates `datanames()` #347

averissimo commented Oct 28, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024

github-actions bot commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

gogonzo left a comment

Adds names() function and deprecates datanames() #347

Adds names() function and deprecates datanames() #347

Conversation

averissimo commented Oct 28, 2024 • edited Loading

Pull Request

Blockers

Changes description

github-actions bot commented Nov 5, 2024 • edited Loading

Code Coverage Summary

Diff against main

github-actions bot commented Nov 5, 2024

Unit Tests Summary

github-actions bot commented Nov 5, 2024 • edited Loading

Unit Tests Summary

github-actions bot commented Nov 5, 2024 • edited Loading

Unit Test Performance Difference

gogonzo left a comment

Choose a reason for hiding this comment

Adds `names()` function and deprecates `datanames()` #347

Adds `names()` function and deprecates `datanames()` #347

averissimo commented Oct 28, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading