Package: roxylint 0.1.0
Doug Kelkhoff
roxylint: Lint 'roxygen2'-Generated Documentation
Provides formatting linting to 'roxygen2' tags. Linters report 'roxygen2' tags that do not conform to a standard style. These linters can be a helpful check for building more consistent documentation and to provide reminders about best practices or checks for typos. Default linting suites are provided for common style guides such as the one followed by the 'tidyverse', though custom linters can be registered by other packages or be custom-tailored to a specific package.
Authors:
roxylint_0.1.0.tar.gz
roxylint_0.1.0.zip(r-4.5)roxylint_0.1.0.zip(r-4.4)roxylint_0.1.0.zip(r-4.3)
roxylint_0.1.0.tgz(r-4.4-any)roxylint_0.1.0.tgz(r-4.3-any)
roxylint_0.1.0.tar.gz(r-4.5-noble)roxylint_0.1.0.tar.gz(r-4.4-noble)
roxylint_0.1.0.tgz(r-4.4-emscripten)roxylint_0.1.0.tgz(r-4.3-emscripten)
roxylint.pdf |roxylint.html✨
roxylint/json (API)
NEWS
| # Install 'roxylint' in R: |
| install.packages('roxylint', repos = c('https://openpharma.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/openpharma/roxylint/issues
Last updated 9 months agofrom:a46e491073. Checks:OK: 7. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Nov 16 2024 |
| R-4.5-win | OK | Nov 16 2024 |
| R-4.5-linux | OK | Nov 16 2024 |
| R-4.4-win | OK | Nov 16 2024 |
| R-4.4-mac | OK | Nov 16 2024 |
| R-4.3-win | OK | Nov 16 2024 |
| R-4.3-mac | OK | Nov 16 2024 |
Exports:check_linterdemo_taglint_full_stoplint_no_full_stoplint_sentence_caselint_starts_lowercaselint_title_caseregister_lintersroxylinttidytidy_paramtidy_returntidy_seealsotidy_title
Dependencies:brewcallrclicommonmarkcpp11descevaluatefsgluehighrknitrlifecyclemagrittrpkgbuildpkgloadprocessxpspurrrR6rlangroxygen2rprojrootstringistringrvctrswithrxfunxml2yaml
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Apply 'roxygen2' linters | check_linter check_linter.character check_linter.default check_linter.function check_linter.list |
| Get that tag! | demo_tag |
| Assorted linters | linters lint_full_stop lint_no_full_stop lint_sentence_case lint_starts_lowercase lint_title_case tidy tidy_param tidy_return tidy_seealso tidy_title |
| Register linters for new tags | register_linters |
| Roclet for 'roxygen2' style linting | roxylint |
