Add documentation for label_limits option

nhs-r-community / NHSRplotthedots

An SPC package to support NHSE/I 'Making Data Count' programme

https://nhs-r-community.github.io/NHSRplotthedots/

Other

47 stars 21 forks source link

Add documentation for label_limits option #214

Closed francisbarton closed 3 weeks ago

francisbarton commented 1 month ago

[ ] added unit tests and checked code coverage with covr::report() (should aim for 100%)
[x] ran devtools::document()
[x] ran lintr::lint_package() and resolved all lint warnings and notes
[x] ran styler::style_pkg() to make sure code matches the style guidelines
[x] ran R-CMD CHECK and resolved all issues

Added section to README that illustrates the label_limits option. Also tidied up a few syntax bits in one of the test files (not relevant to the above) to remove the 1:20 style shorthand for creating numeric vectors (in particular circumstances this can cause unexpected behaviours and it's safer in general to use seq()).

Closes issue #192

francisbarton commented 1 month ago

Thanks Tom, appreciate you taking a look and leaving such a constructive comment. I tried really hard to keep the PR focused and clean but for some reason - some unwitting action of mine that I don't fully understand - the PR kept getting cluttered with all the other irrelevant commits that belong to other PRs.

I appreciate the need for a small set of diffs that can be properly reviewed, so I will try once again!

francisbarton commented 3 weeks ago

There should have been some changes to the README associated with this PR but I think the relevant commits already got merged in, in #215 ... apologies again for the mess, it was unintentional! The relevant commit for the README changes for this PR is https://github.com/nhs-r-community/NHSRplotthedots/pull/215/commits/26b6cd079a0b8b0e24326b1f60d975b3d82f8309

Anyway, this PR is looking a bit smaller now other branches have been merged into main!