Package: roxytypes 0.1.1
Doug Kelkhoff
roxytypes: Typed Parameter Tags for Integration with 'roxygen2'
Provides typed parameter documentation tags for integration with 'roxygen2'. Typed parameter tags provide a consistent interface for annotating expected types for parameters and returned values. Tools for converting from existing styles are also provided to easily adapt projects which implement typed documentation by convention rather than tag. Use the default format or provide your own.
Authors:
roxytypes_0.1.1.tar.gz
roxytypes_0.1.1.zip(r-4.5)roxytypes_0.1.1.zip(r-4.4)roxytypes_0.1.1.zip(r-4.3)
roxytypes_0.1.1.tgz(r-4.4-any)roxytypes_0.1.1.tgz(r-4.3-any)
roxytypes_0.1.1.tar.gz(r-4.5-noble)roxytypes_0.1.1.tar.gz(r-4.4-noble)
roxytypes_0.1.1.tgz(r-4.4-emscripten)roxytypes_0.1.1.tgz(r-4.3-emscripten)
roxytypes.pdf |roxytypes.html✨
roxytypes/json (API)
NEWS
| # Install 'roxytypes' in R: |
| install.packages('roxytypes', repos = c('https://openpharma.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/openpharma/roxytypes/issues
Last updated 4 days agofrom:6aa5a464b0. Checks:OK: 7. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Oct 01 2024 |
| R-4.5-win | OK | Oct 01 2024 |
| R-4.5-linux | OK | Oct 01 2024 |
| R-4.4-win | OK | Oct 01 2024 |
| R-4.4-mac | OK | Oct 01 2024 |
| R-4.3-win | OK | Oct 01 2024 |
| R-4.3-mac | OK | Oct 01 2024 |
Exports:convertdefault_formatre_anyre_backticked
Dependencies:brewcallrclicommonmarkcpp11descevaluatefsgluehighrknitrlifecyclemagrittrpkgbuildpkgloadprocessxpspurrrR6rlangroxygen2rprojrootstringistringrvctrswithrxfunxml2yaml
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Build format regular expression | build_format_regex escape_non_glue_re re_any re_backticked |
| Convert 'roxygen2' tags to 'roxytypes' tags | convert |
| Default formatter for @typed | default_format |
| A helper to reliably read DCF files | read_dcf_asis |
| 'roxygen2' @typed tag parsing | roxy_tag_parse.roxy_tag_typed |
| 'roxygen2' @typedreturn tag parsing | roxy_tag_parse.roxy_tag_typedreturn |
| 'roxygen2' @typed tag rd section population | roxy_tag_rd.roxy_tag_typed |
| 'roxygen2' @typedreturn tag rd section population | roxy_tag_rd.roxy_tag_typedreturn |
| 'roxytypes' tags | tags typed |
| 'roxygen2' @typedreturn tag | typedreturn |
| A helper to apply field names to all roxy_tag val fields | with_roxy_field_subclass |
