Format for converting an R Markdown document to a grid oriented dashboard layout. The dashboard flexibly adapts the size of it's plots and htmlwidgets to its containing web page.
flex_dashboard(
fig_width = 6,
fig_height = 4.8,
fig_retina = 2,
fig_mobile = TRUE,
dev = "png",
self_contained = TRUE,
favicon = NULL,
logo = NULL,
social = NULL,
source_code = NULL,
navbar = NULL,
orientation = c("columns", "rows"),
vertical_layout = c("fill", "scroll"),
storyboard = FALSE,
theme = "default",
highlight = "default",
mathjax = "default",
extra_dependencies = NULL,
css = NULL,
includes = NULL,
lib_dir = NULL,
md_extensions = NULL,
pandoc_args = NULL,
devel = FALSE,
resize_reload = TRUE,
...
)Default width (in inches) for figures
Default height (in inches) for figures
Scaling to perform for retina displays (defaults to 2). Note that for flexdashboard enabling retina scaling provides for both crisper graphics on retina screens but also much higher quality auto-scaling of R graphics within flexdashboard containers.
Create an additional rendering of each R graphics figure
optimized for rendering on mobile devices oriented in portrait mode. If
TRUE, creates a figure which is 3.75 x 4.80 inches wide; if
FALSE, create no additional figure for mobile devices; if a numeric
vector of length 2, creates a mobile figure with the specified width and
height.
Graphics device to use for figure output (defaults to png)
Produce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. Note that even for self contained documents MathJax is still loaded externally (this is necessary because of its size).
Path to graphic to be used as a favicon for the dashboard. Pass
NULL to use no favicon.
Path to graphic to be used as a logo for the dashboard. Pass
NULL to not include a logo. Note that no scaling is performed on the
logo image, so it should fit exactly within the dimensions of the navigation
bar (48 pixels high for the default "cosmo" theme, other themes may have
slightly different navigation bar heights).
Specify a character vector of social sharing services to
automatically add sharing links for them on the navbar. Valid values
are "twitter", "facebook", "linkedin", and "pinterest" (more than one
service can be specified).
URL for source code of dashboard (used primarily for
publishing flexdashboard examples). Automatically creates a navbar
item which links to the source code.
Optional list of elements to be placed on the flexdashboard
navigation bar. Each element should be a list containing a title
and/or icon field, an href field. Optional fields
target (e.g. "_blank") and align ("left" or "right") are also
supported.
Determines whether level 2 headings are treated as dashboard rows or dashboard columns.
Vertical layout behavior: "fill" to vertically resize charts so they completely fill the page; "scroll" to layout charts at their natural height, scrolling the page if necessary.
TRUE to use a storyboard layout scheme that places
each dashboard component in a navigable storyboard frame. When a storyboard
layout is used the orientation and vertical_layout arguments
are ignored. When creating a dashbaord with multiple pages you should apply
the `.storyboard` attribute to individual pages rather than using the
global storyboard option.
One of the following: * A [bslib::bs_theme()] object (or a list of [bslib::bs_theme()] argument values) * Use this option to choose any [Bootstrap version](https://rstudio.github.io/bslib/articles/bslib.html#bootstrap-versions), [Bootswatch theme](https://rstudio.github.io/bslib/articles/bslib.html#bootswatch-themes), or implement a [custom theme](https://rstudio.github.io/bslib/articles/bslib.html#custom-themes). * In this case, any `.scss`/`.sass` files provided to the `css` parameter may utilize the `theme`'s underlying Sass utilities (e.g., variables, mixins, etc). * A character string specifying a [Bootswatch 3](https://bootswatch.com/3/) theme name (for backwards-compatibility). The "cosmo" theme is used when "default" is specified.
Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", and "haddock". Pass NULL to prevent syntax highlighting.
Include mathjax. The "default" option uses an https URL from a
MathJax CDN. The "local" option uses a local version of MathJax (which is
copied into the output directory). You can pass an alternate URL or pass
NULL to exclude MathJax entirely.
Extra dependencies as a list of the
html_dependency class objects typically generated by
htmltools:htmlDependency().
CSS and/or Sass files to include. Files with an extension of .sass
or .scss are compiled to CSS via sass::sass(). Also, if theme is a
bslib::bs_theme() object, Sass code may reference the relevant Bootstrap
Sass variables, functions, mixins, etc.
Named list of additional content to include within the
document (typically created using the includes function).
Directory to copy dependent HTML libraries (e.g. jquery,
bootstrap, etc.) into. By default this will be the name of the document with
_files appended to it.
Markdown extensions to be added or removed from the
default definition of R Markdown. See the rmarkdown_format for
additional details.
Additional command line options to pass to pandoc
Enable development mode (used for development of the format itself, not useful for users of the format).
Disable the auto-reloading behavior when the window is resized. Useful when debugging large flexdashboard applications and this functionality is not needed.
Other arguments to [rmarkdown::html_document_base()].
See the flexdashboard website for additional documentation: https://pkgs.rstudio.com/flexdashboard/