docvar: cats a string representation of a variable's structure, and...
In jorritvm/jrutils: utility functions for R
docvar R Documentation
cats a string representation of a variable's structure,
and puts it on the clipboard if desired, to be pasted in roxygen doc
Description
cats a string representation of a variable's structure,
and puts it on the clipboard if desired, to be pasted in roxygen doc
Usage
docvar(var, type = "return", cb = TRUE)
Arguments
var
the variable you wish to document
type
is it roxygen 'param' or 'return'?
cb
TRUE FALSE : put doc on clipboard
Value
a string documenting the variable
jorritvm/jrutils documentation built on Feb. 14, 2023, 11:33 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.
| docvar | R Documentation |
cats a string representation of a variable's structure, and puts it on the clipboard if desired, to be pasted in roxygen doc
Description
cats a string representation of a variable's structure, and puts it on the clipboard if desired, to be pasted in roxygen doc
Usage
docvar(var, type = "return", cb = TRUE)
Arguments
var |
the variable you wish to document |
type |
is it roxygen 'param' or 'return'? |
cb |
TRUE FALSE : put doc on clipboard |
Value
a string documenting the variable
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.