Pre-release activities

[kartikeyakirar]

part of insightsengineering/nestdevs-tasks#48

• Review and update:
  - README.md (check example code)
  - NEWS.md

• Run urlchecker::url_check() to identify broken links and fix

• Review functions:
  - @example tag, make sure it runs, fix if otherwise
  - Make sure functions has @return tag to document the return value
  - no \dontrun tag, replace with if(interactive()) if needed

• Sanity check of all vignettes, make sure there is no typo, no wrong format, etc.

• Run R CMD check --as-cran make sure everything pass

• Package Title is not duplicated in Package Description in DESCRIPTION file (e.g. this happens in teal.slice currently)

• All package names in Title and Description fields of DESCRIPTION file are quoted with '

• You have checked the Package Release Template https://github.com/insightsengineering/teal.reporter/pull/205/files

• Make sure there are no ::: in examples

• Make sure all teal.* mentions are lower-cased and quoted

• Make Sure inst/WORDLIST is minimalized

• Make sure non-exported functions do not have examples

• Make sure each link to our documentation hosted with pkgdown on github pages do not have /main/ in the address but it has /latest/ instead, so we always expose the documentation of the latest release and not what's currently on main branch but not yet released

• Consistent usage of <xyz> object/datasets (if any).

• switch from title case into sentence case for title and description of functions.

• remove old rd syntax

[github-actions]

Code Coverage Summary

Filename                         Stmts    Miss  Cover    Missing
-----------------------------  -------  ------  -------  ------------------
R/cdisc_data.R                       1       1  0.00%    35
R/default_cdisc_join_keys.R         11      11  0.00%    17-35
R/deprecated.R                      57      57  0.00%    17-341
R/dummy_function.R                   2       2  0.00%    14-15
R/formatters_var_labels.R           36      11  69.44%   59, 68-79
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%   33-36
R/join_keys.R                       21       0  100.00%
R/teal_data-class.R                 25       1  96.00%   70
R/teal_data-datanames.R             10       0  100.00%
R/teal_data-get_code.R              15       1  93.33%   57
R/teal_data-show.R                   4       4  0.00%    13-18
R/teal_data.R                       22       9  59.09%   28, 37-43, 46
R/testhat-helpers.R                 26       0  100.00%
R/topological_sort.R                32       0  100.00%
R/utils-get_code_dependency.R      110       1  99.09%   43
R/verify.R                          42      11  73.81%   63, 93-97, 100-104
R/zzz.R                             10      10  0.00%    4-16
TOTAL                              765     122  84.05%

Diff against main

Filename                     Stmts    Miss  Cover
-------------------------  -------  ------  --------
R/deprecated.R                 -12     -12  +100.00%
R/dummy_function.R              -3      -3  +100.00%
R/formatters_var_labels.R      -15     -40  +69.44%
TOTAL                          -30     -55  +6.32%

Results for commit: 229d51b

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   14 suites   1s ⏱️
175 tests 173 ✅ 2 💤 0 ❌
242 runs  240 ✅ 2 💤 0 ❌

Results for commit 229d51b.

♻️ This comment has been updated with latest results.

[github-actions]

Unit Test Performance Difference

Test Suite	$Status$	Time on main	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
formatters_var_labels	👶		$+0.04$	$+7$	$0$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
formatters_var_labels	👶		$+0.01$	col_labels_accepts_an_empty_data.frame
formatters_var_labels	👶		$+0.00$	col_labels_returns_a_named_vector_of_NA_when_fill_FALSE_and_there_are_no_labels
formatters_var_labels	👶		$+0.00$	col_labels_returns_a_vector_of_column_names_when_fill_TRUE_and_there_are_no_labels
formatters_var_labels	👶		$+0.00$	col_labels_returns_empty_character_vector_for_a_data.frame_with_no_columns
formatters_var_labels	👶		$+0.00$	col_relabel_correctly_changes_column_labels_in_a_data_frame
formatters_var_labels	👶		$+0.01$	col_relabel_returns_the_original_data.frame_when_no_new_labels_are_specified
formatters_var_labels	👶		$+0.01$	col_relabel_throws_an_error_for_non_existent_columns
join_keys	💀	$0.01$	$-0.01$	join_keys_doesn_t_accept_other_objects_than_teal_data_TealData_and_join_key
join_keys	👶		$+0.01$	join_keys_only_accepts_teal_data_and_join_key_arguments

Results for commit b9c2393

♻️ This comment has been updated with latest results.

[pawelru]

Shall we also update installation description similarly to what you did for teal?

[kartikeyakirar]

do you meanREADME.mdfile? It updated here similarly https://github.com/insightsengineering/teal.data/pull/240/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5

[pawelru]

That's right. I was looking at https://github.com/insightsengineering/teal.data/tree/pre-release-cleanup%40main where I cannot see the changes they are there if I open https://github.com/insightsengineering/teal.data/blob/pre-release-cleanup%40main/README.md. That's strange.
Anyway, this is done 👍