[skip vbump] update description and news, preping for cran submission

[shajoezhu]

Pull Request

Fixes #nnn

[github-actions]

Code Coverage Summary

Filename         Stmts    Miss  Cover    Missing
-------------  -------  ------  -------  --------------------------
R/radab.R          284       1  99.65%   390
R/radae.R          198       3  98.48%   76, 95, 284
R/radaette.R       203       4  98.03%   50, 72, 78, 260
R/radcm.R          150       2  98.67%   51, 204
R/raddv.R           91       2  97.80%   54, 137
R/radeg.R          270       1  99.63%   370
R/radex.R          229       1  99.56%   320
R/radhy.R          136       1  99.26%   198
R/radlb.R          334       1  99.70%   426
R/radmh.R           93       2  97.85%   45, 134
R/radpc.R           85       1  98.82%   125
R/radpp.R           83       1  98.80%   153
R/radqlqc.R       1024       7  99.32%   331, 820, 1112-1116
R/radqs.R          118       1  99.15%   185
R/radrs.R          122       3  97.54%   47, 54, 183
R/radsaftte.R        1       0  100.00%
R/radsl.R          180       1  99.44%   260
R/radsub.R         140       2  98.57%   171, 235
R/radtr.R          124       0  100.00%
R/radtte.R         208       4  98.08%   52, 72, 84, 279
R/radvs.R          178       1  99.44%   251
R/utils.R          149      11  92.62%   59, 240, 252, 256, 286-292
TOTAL             4400      50  98.86%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  -------
R/utils.R        +1       0  +0.05%
TOTAL            +1       0  +0.00%

Results for commit: dde3c17

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   4 suites   28s ⏱️
 61 tests 40 ✅ 21 💤 0 ❌
106 runs  85 ✅ 21 💤 0 ❌

Results for commit dde3c17.

♻️ This comment has been updated with latest results.

[edelarua]

Lgtm!

[shajoezhu]

CRAN feedback

• The Description field is intended to be a (one paragraph) description of
  what the package does and why it may be useful. Please add more details
  about the package functionality and implemented methods in your
  Description text.

• Please always explain all acronyms in the description text. -> SDTM,
  ADAM, CDISC

• The LICENSE file is only needed if you have additional restrictions to
  the license which you have not? In that case omit the file and its
  reference in the DESCRIPTION file.

• Please add \value to .Rd files regarding exported methods and explain
  the functions results in the documentation. Please write about the
  structure of the output (class) and also what the output means. (If a
  function does not return a value, please document that too, e.g.
  \value{No return value, called for side effects} or similar)
  Missing Rd-tags:
  mutate_na.Rd: \value

• You have examples for unexported functions. Please either omit these
  examples or export these functions.
  "Using foo:::f instead of foo::f allows access to unexported objects.
  This is generally not recommended, as the semantics of unexported
  objects may be changed by the package author in routine maintenance."
  Used ::: in documentation:
  man/apply_metadata.Rd:
  adsl <- random.cdisc.data:::apply_metadata(adsl,
  file.path(yaml_path, "ADSL.yml"), FALSE)
  man/apply_metadata.Rd:
  adsub <- random.cdisc.data:::apply_metadata(adsub,
  file.path(yaml_path, "ADSUB.yml"), TRUE, file.path(yaml_path, "ADSL.yml"))
  man/h_adqlqc.Rd:
  qs <- random.cdisc.data:::get_qs_data(adsl, n_assessments = 5,
  seed = 1, na_percentage = 0.1)
  man/h_adqlqc.Rd:
  df <- dplyr::mutate(dplyr::mutate(dplyr::left_join(adsl, qs, by
  = c("STUDYID", "USUBJID"), multiple = "all"), AVISIT = VISIT, PARAMCD =
  QSTESTCD, AVISITN = VISITNUM), ADTM =
  random.cdisc.data:::get_random_dates_between(TRTSDTM, TRTEDTM, AVISITN))
  man/h_adqlqc.Rd:
  adqlqc1 <- random.cdisc.data:::prep_adqlqc(df = qs)
  man/h_adqlqc.Rd:
  df_scales <- random.cdisc.data:::calc_scales(df)
  man/h_adqlqc.Rd:
  adqlqc <- random.cdisc.data:::derv_chgcat1(dataset =
  dplyr::select(adqlqc, -CHGCAT1))
  ma [... truncated]
  Please omit one colon.

• \dontrun{} should only be used if the example really cannot be executed
  (e.g. because of missing additional software, missing API keys, ...) by
  the user. That's why wrapping examples in \dontrun{} adds the comment
  ("# Not run:") as a warning for the user. Does not seem necessary.
  Please replace \dontrun with \donttest. -> man/h_adqlqc.Rd
  Please unwrap the examples if they are executable in < 5 sec, or replace
  dontrun{} with \donttest{}.

• Please do not modify the global environment (e.g. by using <<-) in your
  functions. This is not allowed by the CRAN policies.
  -> R/utils.R