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

news -> Change log #95

Closed thebioengineer closed 3 years ago

thebioengineer commented 3 years ago

Addresses #93 by changing code naming convention and location to create a "change log" file (change_log.md) in the validation folder. By putting the change log there, we have several benefits:

no reliance on parsing by base R of file (we have complete control)
automatically copied as part of validated build since it lives in the validation folder
simplify testing, not reliant on installation of the package to get the news

thebioengineer commented 3 years ago

94 is also blocked by CI failures in R < 3.6 due to changes in how R treats and records news. This will solve that too.

mariev commented 3 years ago

I just noticed that vt_use_change_log does not inform the user re: creating change_log.md; this is unlike behavior in vt_use_req. Is that of concern?

thebioengineer commented 3 years ago

Good point. I'll update and merge