InheritParamsTag-class: @inheritParams: Inherit parameters from another function.
In hadley/roxygen3: In-source documentation for R
Description
This tag will bring in all documentation for parameters that are
undocumented in the current function, but documented in the source
function. The source can be a function in the current package,
function, or another package package::function.
Details
You may use multiple @inheritParams tags to inherit parameters
from multiple functions.
Tag Usage
1
2
#' @inheritParams local_function
#' @inheritParams package::remote_function
hadley/roxygen3 documentation built on May 17, 2019, 12:16 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.
Description
This tag will bring in all documentation for parameters that are
undocumented in the current function, but documented in the source
function. The source can be a function in the current package,
function, or another package package::function.
Details
You may use multiple @inheritParams tags to inherit parameters
from multiple functions.
Tag Usage
1 2 | #' @inheritParams local_function
#' @inheritParams package::remote_function
|
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.