search

phuse-org / valtools

Validation framework for R packages used in clinical research and drug development.
https://phuse-org.github.io/valtools/
Other
51 stars 10 forks source link

Validation roxygen tags #17

Closed thebioengineer closed 3 years ago

thebioengineer commented 3 years ago

Add two new roxygen tags to supersede the @section Last Updated By and @section Last Update Date nomenclature.

Now users can do:

#' @title Best title ever
#' @editor MY NAME
#' @editDate 2021-02-19
my_func <- function(){}
mariev commented 3 years ago

do we need the roxygen2:: if we have correct @importFrom documentation?

edit: we should also prob. have a discussion regarding date conventions to check generally. While I prefer iso, I think mdy and ddMMMYYYY are also quite popular.

thebioengineer commented 3 years ago

removed the :: references. I think you are correct.

WRT the date conventions, I think YMD(iso) and MDY are the most common. Added "dmy" as well as the last resort. We can comment that will be the order of parsing dates