func_header: Produce function header text
In bobverity/bobfunctions2: Bob's utility functions
func_header R Documentation
Produce function header text
Description
Produce header text for a single function to paste into script.
Different header types are available for different types of function (see
below). Header text is written in roxygen format.
Usage
func_header(type = 1, copy_clipboard = FALSE)
Arguments
type
switches between the following text blocks:
basic function header
complete function header with all the bells and whistles
function that is not exported
S3 method, e.g. print.my_class()
copy_clipboard
whether the header text should also be copied to the
clipboard. This should be FALSE when running on PC as it can cause R
to crash.
bobverity/bobfunctions2 documentation built on July 4, 2023, 8:55 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.
| func_header | R Documentation |
Produce function header text
Description
Produce header text for a single function to paste into script. Different header types are available for different types of function (see below). Header text is written in roxygen format.
Usage
func_header(type = 1, copy_clipboard = FALSE)
Arguments
type |
switches between the following text blocks:
|
copy_clipboard |
whether the header text should also be copied to the
clipboard. This should be |
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.