Title: | Create slide decks and grid layout paginated HTML reports |
---|---|
Description: | An extension to the pagedown package that uses the CSS grid layout module to provide extensive layout control of page based Rmarkdown reports. |
Authors: | Matt Kerlogue [aut, cre] |
Maintainer: | Matt Kerlogue <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.0.0.9000 |
Built: | 2024-10-29 03:16:01 UTC |
Source: | https://github.com/mattkerlogue/deckhand2 |
Grid layout pages
deckhand(css = NULL, page_size = NULL, ...)
deckhand(css = NULL, page_size = NULL, ...)
css |
Additional CSS files to include |
page_size |
Set page size |
... |
Additional arguments passed to pagedown |
The deckhand R Markdown formats use CSS to manage page layout, to assist those with limited knowledge of CSS there is a simple YAML format for managing general settings.
deckhand_config_to_css( config_yml = NULL, write_files = TRUE, dh_dir = NULL, display = !write_files )
deckhand_config_to_css( config_yml = NULL, write_files = TRUE, dh_dir = NULL, display = !write_files )
config_yml |
A YAML file with deckhand configuration settings |
write_files |
Whether to write the CSS to a file |
dh_dir |
Optionally the folder to look for config files |
display |
Whether to display the generated CSS in the console |
If write_files = TRUE
invisibly returns the path of the CSS file,
otherwise it will print the CSS to the console and return it as a
character vector.
If path
and template
are NULL
(the default), deckhand will copy the
default YAML file as _deckhand.yml
in directory defined by here::here()
.
If using RStudio the file will be opened as a new source document for you
to edit.
new_config_yml(path = NULL, template = NULL)
new_config_yml(path = NULL, template = NULL)
path |
The path of the new file |
template |
The path of a template file |