flex_templates: Basic metadata for all flexdashboard templates in snapflex

In leonawicz/snapflex: Flexdashboards for SNAP Data Sets

Description

This function returns a data frame with basic meta data for all flexdashboard templates in snapflex. This includes the following information:

Usage

flex_templates()

Details

• the template ID used for generating a local flexdashboard.

• a brief description of the template.

• the variables included in the flexdashboard.

• whether any variables are displayed as deltas in comparison to a baseline rather than as raw values.

• intra- and/or inter-annual time period information if applicable.

• whether Shiny is used at runtime to launch a local instance of an interactive flexdashboard rather than a standalone html document.

• whether the template requires any additional parameters specified by the user.

Regarding required template-specific parameters, note that all templates in snapflex accept some parameters that are optional rather than required because the templates have set defaults for these if ignored. For example, all templates accept gfont , regular, bold and snaptheme. Since optional parameters are always available and are safely ignored, entries in the final column of the data frame are TRUE only if a template has required parameters where the user must always specify the value when rendering a template. Use flex_params to view a table of information about all parameters available for a given template.

Value

a data frame.

See Also

flex_templates flex_params

Examples

flex_templates()

leonawicz/snapflex documentation built on May 21, 2019, 9:21 a.m.