roxygen_param_by_vars: Standard Text for the 'by_vars' Argument
In admiraldev: Utility Functions and Development Tools for the Admiral Package Family
View source: R/roxygen_helpers.R
roxygen_param_by_vars R Documentation
Standard Text for the by_vars Argument
Description
This function provides standardized documentation text for the by_vars
argument used in {admiral} functions.
Usage
roxygen_param_by_vars(rename = FALSE)
Arguments
rename
Should the renaming feature be documented?
If TRUE, the text includes information about renaming variables using
named elements in by_vars.
- Permitted values
TRUE, FALSE
- Default value
FALSE
Details
The benefits of having a programmatic way to write documentation is that if
any changes need to be made, modifying this function scales across the
codebase, can be tested, and is less prone to user-error such as typos or
grammar mistakes.
Value
A character string with the standardized documentation text for
the by_vars argument
See Also
Other documentation:
roxygen_order_na_handling(),
roxygen_param_dataset(),
roxygen_save_memory()
Examples
roxygen_param_by_vars()
roxygen_param_by_vars(rename = TRUE)
admiraldev documentation built on June 10, 2026, 5:07 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/roxygen_helpers.R
| roxygen_param_by_vars | R Documentation |
Standard Text for the by_vars Argument
Description
This function provides standardized documentation text for the by_vars
argument used in {admiral} functions.
Usage
roxygen_param_by_vars(rename = FALSE)
Arguments
rename |
Should the renaming feature be documented? If
|
Details
The benefits of having a programmatic way to write documentation is that if any changes need to be made, modifying this function scales across the codebase, can be tested, and is less prone to user-error such as typos or grammar mistakes.
Value
A character string with the standardized documentation text for
the by_vars argument
See Also
Other documentation:
roxygen_order_na_handling(),
roxygen_param_dataset(),
roxygen_save_memory()
Examples
roxygen_param_by_vars()
roxygen_param_by_vars(rename = TRUE)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.