search

Public-Health-Scotland / phsmethods

An R package to standardise methods used in Public Health Scotland (https://public-health-scotland.github.io/phsmethods/)
https://public-health-scotland.github.io/phsmethods/
54 stars 13 forks source link

Add a `\value` to rename.Rd #119

Closed Moohan closed 8 months ago

Moohan commented 8 months ago

I don't really like this as it doesn't make any sense.

It's also not consistent with the tidyverse advice: https://lifecycle.r-lib.org/articles/communicate.html#rename-a-function

or the example they show (rvest) - https://github.com/tidyverse/rvest/blob/HEAD/R/rename.R https://github.com/tidyverse/rvest/blob/0cda79b4671bab46ba5717c8658ff81030091281/man/rename.Rd

However, I'm pretty sure it should satisfy CRAN's requirements.

codecov[bot] commented 8 months ago

Codecov Report

Merging #119 (c4569cd) into master (11ae4b0) will not change coverage. The diff coverage is n/a.

:exclamation: Current head c4569cd differs from pull request most recent head 096e5e1. Consider uploading reports for the commit 096e5e1 to get more accurate results

@@           Coverage Diff           @@
##           master     #119   +/-   ##
=======================================
  Coverage   97.41%   97.41%           
=======================================
  Files          13       13           
  Lines         425      425           
=======================================
  Hits          414      414           
  Misses         11       11
Files Coverage Δ
R/rename.R 27.27% <ø> (ø)