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

Update the documentation #114

Closed Moohan closed 11 months ago

Moohan commented 1 year ago

I added return values to the documentation where it was missing - per the CRAN comments.

I also converted the documentation to Markdown (using roxygen2md as recommended), as it makes the documentation easier to write and maintain.

I also ran goodpractice::goodpractice() to check if anything else was possibly missed and this led to a few more cosmetic changes and the removal of purrr from Imports as it's not actually being used in the package.

codecov[bot] commented 1 year ago

Codecov Report

Merging #114 (c163b62) into master (9e53056) will increase coverage by 0.10%. The diff coverage is 100.00%.

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

@@            Coverage Diff             @@
##           master     #114      +/-   ##
==========================================
+ Coverage   97.30%   97.41%   +0.10%     
==========================================
  Files          13       13              
  Lines         408      425      +17     
==========================================
+ Hits          397      414      +17     
  Misses         11       11              
Files Coverage Δ
R/age_calculate.R 100.00% <100.00%> (ø)
R/chi_check.R 100.00% <ø> (ø)
R/chi_pad.R 100.00% <100.00%> (ø)
R/create_age_groups.R 100.00% <ø> (ø)
R/dob_from_chi.R 100.00% <100.00%> (ø)
R/extract_fin_year.R 100.00% <ø> (ø)
R/file_size.R 100.00% <ø> (ø)
R/format_postcode.R 100.00% <ø> (ø)
R/make_inheritance_checks.R 90.32% <100.00%> (+1.43%) :arrow_up:
R/match_area.R 100.00% <ø> (ø)
... and 3 more