roxdoc: Documentation template
In AkselA/R-projector: Projector Helps To Initiate And Develop R Packages
Description
Usage
Arguments
Details
Value
See Also
Examples
Description
Create a function documentation template
Usage
1
Arguments
fun
function or name of function
to.clipboard
logical; should results be copied to the clipboard?
Details
The function arguments are returned as with params.
In addition other commonly used Roxygen2 tags are included.
Value
Either to the console, or clipboard, a function documentation template, as
appropriate for Roxygen2 use, is returned. Tags included are @param
(with argument names), @details, @return, @seealso,
@examples and @export.
See Also
Examples
1
2
AkselA/R-projector documentation built on June 19, 2020, 4:24 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 Usage Arguments Details Value See Also Examples
Description
Create a function documentation template
Usage
1 |
Arguments
fun |
function or name of function |
to.clipboard |
logical; should results be copied to the clipboard? |
Details
The function arguments are returned as with params.
In addition other commonly used Roxygen2 tags are included.
Value
Either to the console, or clipboard, a function documentation template, as
appropriate for Roxygen2 use, is returned. Tags included are @param
(with argument names), @details, @return, @seealso,
@examples and @export.
See Also
Examples
1 2 |
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.