has_docstring: has_docstring
In karsfri/HMSr: Theme and functions for HMS
Description
Usage
Arguments
Value
View source: R/GenerateDocumentation.R
Description
This function has been stolen from the docsting package.
It checks the function for roxygen type comments (any no order necessary)
Usage
1
has_docstring(fun, fun_name = as.character(substitute(fun)))
Arguments
fun
a function to document ( will error if no r oxygen comments in it)
fun_name
defaults to a string of the function name, otherwise defines the name the documentaion file will be named
Value
The function returns the text from r oxygen comments
karsfri/HMSr documentation built on Feb. 26, 2020, 10:36 a.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 Value
View source: R/GenerateDocumentation.R
Description
This function has been stolen from the docsting package. It checks the function for roxygen type comments (any no order necessary)
Usage
1 | has_docstring(fun, fun_name = as.character(substitute(fun)))
|
Arguments
fun |
a function to document ( will error if no r oxygen comments in it) |
fun_name |
defaults to a string of the function name, otherwise defines the name the documentaion file will be named |
Value
The function returns the text from r oxygen comments
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.