CRAN-ification - Githubissues

pharmaverse / sdtmchecks

Analysis facing checks for SDTM data

https://pharmaverse.github.io/sdtmchecks/

Apache License 2.0

20 stars 6 forks source link

CRAN-ification #335

Closed harriscw closed 6 days ago

harriscw commented 1 month ago

Lets go through these links to make the package CRAN ready

laywang142 commented 1 month ago

[x] usethis::use_news_md() -> NEWS.md file exists
[x] usethis::use_cran_comments() -> cran-comments.md file exists
[x] Update (aspirational) install instructions in README -> install instructions in README exist
[x] Proofread Title: and Description: -> title: "Data Quality Checks for SDTM Dataset"; description: "Functions to identify common data issues in SDTM data. These checks are intended to be generalizable, actionable, and meaningful for analysis."
[x] Check that all exported functions have @returns and @examples
[x] Check that Authors@R: includes a copyright holder (role ‘cph’)
[x] Check licensing of included files
[ ] Review https://github.com/DavisVaughan/extrachecks
[x] Review dontrun usage and remove if possible @harriscw
[x] check url in package
[x] check license year

laywang142 commented 1 month ago

check_ae_aedecod (???) <- replace the return strings below with the return string from here Functions missing @returns (none of them were missing @example):

[x] check_ae_aelat.R
[x] check_ae_death.R
[x] check_cm_cmlat.R
[x] check_cm_cmlat_prior_ocular.R
[x] check_dd_death_date.R
[x] check_ds_dsdecod_death.R
[x] check_ds_sc_strat.R
[x] check_ec_sc_lat.R
[x] check_ex_extrt_exoccur.R
[x] check_ex_visit.R
[x] check_oe_bcva_4m_vs_1m_req.R
[x] check_oe_bcva_tot_mismatch.R
[x] check_oe_sc_lat_count_fingers.R
[x] check_pr_prlat.R
[x] check_qs_qsdtc_after_dd.R
[x] check_sc_dm_eligcrit.R
[x] check_sc_dm_seyeselc.R
[x] check_tr_dup.R

laywang142 commented 1 month ago

Will this be an issue?

laywang142 commented 3 weeks ago

According to the Davis Vaughan extra checks, we should remove the words "functions to" from the description in the DESCRIPTION file as well as consider adding a few more sentences. detailed description

6/10/24: remove 'function' from DESCRIPTION and replace with 'checks'

laywang142 commented 3 weeks ago

This was in the LICENSE.md file. Should it be updated?

6/10/24: leave as-is

laywang142 commented 3 weeks ago

NOTE: tried to update the README but I had trouble rendering the .rmd file to a .md file

solution: update .rmd only and don't need to knit/touch .md