flex_params: Template parameters
In leonawicz/snapflex: Flexdashboards for SNAP Data Sets
Description
Usage
Arguments
Details
Value
See Also
Examples
Description
List the required and optional parameters for a flexdashboard template passed to flex.
Usage
1
flex_params(template)
Arguments
template
character, the flexdashboard template. See flex_templates.
Details
This function returns a data frame with three columns. The first contains parameter names pertaining to a specific template.
The second is a column of default values. If NA, the parameter is required to be passed by the user any time the template is rendered using flex.
Otherwise, the parameter is optional, given that a default value is set by the template if the user ignores the parameter.
The third is a column of hints, containing information regarding what constitutes valid values for the parameters in case you are less familiar with the SNAPverse and SNAP climate data sets.
Value
a list or NULL.
See Also
flex_templates flex
Examples
1
flex_params("psc1")
leonawicz/snapflex documentation built on May 21, 2019, 9:21 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 Details Value See Also Examples
Description
List the required and optional parameters for a flexdashboard template passed to flex.
Usage
1 | flex_params(template)
|
Arguments
template |
character, the flexdashboard template. See |
Details
This function returns a data frame with three columns. The first contains parameter names pertaining to a specific template.
The second is a column of default values. If NA, the parameter is required to be passed by the user any time the template is rendered using flex.
Otherwise, the parameter is optional, given that a default value is set by the template if the user ignores the parameter.
The third is a column of hints, containing information regarding what constitutes valid values for the parameters in case you are less familiar with the SNAPverse and SNAP climate data sets.
Value
a list or NULL.
See Also
flex_templates flex
Examples
1 | flex_params("psc1")
|
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.