| Title: | UNHCR Branded Templates for R Markdown Documents |
|---|---|
| Description: | Create United Nations High Commissioner for Refugees (UNHCR) branded documents, presentations, and reports using R Markdown templates. This package provides customized formats that align with UNHCR's official brand guidelines for creating professional PDF reports, Word documents, PowerPoint presentations, and HTML outputs. |
| Authors: | Cédric Vidonne [aut, cre], Ahmadou Dicko [aut], Edouard Legoupil [aut], UNHCR [cph] |
| Maintainer: | Cédric Vidonne <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.6.0.9000 |
| Built: | 2025-02-17 06:02:18 UTC |
| Source: | https://github.com/unhcr-dataviz/unhcrdown |
Format for converting from R Markdown to an UNHCR branded Word simple document
docx_simple(...)docx_simple(...)
... |
extra parameters to pass to |
An R Markdown output format.
## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR Word Document' output: unhcrdown::docx_simple --- ## Introduction This is an example of a UNHCR-branded Word document created using `unhcrdown::docx_simple`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::docx_simple(), output_dir = tempdir() ) ## End(Not run)## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR Word Document' output: unhcrdown::docx_simple --- ## Introduction This is an example of a UNHCR-branded Word document created using `unhcrdown::docx_simple`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::docx_simple(), output_dir = tempdir() ) ## End(Not run)
Format for converting from R Markdown to an UNHCR branded HTML website
html_page(...)html_page(...)
... |
extra parameters to pass to |
An R Markdown output format.
## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR HTML Page' output: unhcrdown::html_page --- ## Introduction This is an example of a UNHCR-branded HTML page created using `unhcrdown::html_page`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::html_page(), output_dir = tempdir() ) # View the rendered HTML file browseURL(render_file) ## End(Not run)## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR HTML Page' output: unhcrdown::html_page --- ## Introduction This is an example of a UNHCR-branded HTML page created using `unhcrdown::html_page`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::html_page(), output_dir = tempdir() ) # View the rendered HTML file browseURL(render_file) ## End(Not run)
Format for converting from R Markdown to an UNHCR branded HTML presentation
html_slides(other_css = NULL, ...)html_slides(other_css = NULL, ...)
other_css |
Add extra css |
... |
extra parameters to pass to |
An R Markdown output format.
## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR HTML Slides' output: unhcrdown::html_slides --- ## Introduction This is an example of a UNHCR-branded HTML slides created using `unhcrdown::html_slides`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::html_slides(), output_dir = tempdir() ) # View the rendered HTML file browseURL(render_file) ## End(Not run)## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR HTML Slides' output: unhcrdown::html_slides --- ## Introduction This is an example of a UNHCR-branded HTML slides created using `unhcrdown::html_slides`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::html_slides(), output_dir = tempdir() ) # View the rendered HTML file browseURL(render_file) ## End(Not run)
Function for UNHCR paged report template
paged_report( front_img = NULL, img_to_dark = FALSE, other_css = NULL, toc = TRUE, toc_depth = 2, number_sections = FALSE, ... )paged_report( front_img = NULL, img_to_dark = FALSE, other_css = NULL, toc = TRUE, toc_depth = 2, number_sections = FALSE, ... )
front_img |
Cover image |
img_to_dark |
Darken cover image |
other_css |
Add extra css |
toc |
Table of content |
toc_depth |
Table of content depth |
number_sections |
Number section headings |
... |
Arguments passed to pagedown::html_paged |
An R Markdown output format.
## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR HTML' subtitle: 'Paged Report' output: unhcrdown::paged_report --- ## Introduction This is an example of a UNHCR-branded HTML paged report using `unhcrdown::paged_report`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::paged_report(), output_dir = tempdir() ) # View the rendered HTML file browseURL(render_file) ## End(Not run)## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR HTML' subtitle: 'Paged Report' output: unhcrdown::paged_report --- ## Introduction This is an example of a UNHCR-branded HTML paged report using `unhcrdown::paged_report`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::paged_report(), output_dir = tempdir() ) # View the rendered HTML file browseURL(render_file) ## End(Not run)
Function for UNHCR paged simple template
paged_simple(back_html = TRUE, other_css = NULL, number_sections = FALSE, ...)paged_simple(back_html = TRUE, other_css = NULL, number_sections = FALSE, ...)
back_html |
Back-cover HTML including contact information |
other_css |
Add extra css |
number_sections |
Number section headings |
... |
Arguments passed to pagedown::html_paged |
An R Markdown output format.
## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR HTML' subtitle: 'Paged Report Simple' output: unhcrdown::paged_simple --- ## Introduction This is an example of a UNHCR-branded HTML paged report siple using `unhcrdown::paged_simple`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::paged_simple(), output_dir = tempdir() ) # View the rendered HTML file browseURL(render_file) ## End(Not run)## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR HTML' subtitle: 'Paged Report Simple' output: unhcrdown::paged_simple --- ## Introduction This is an example of a UNHCR-branded HTML paged report siple using `unhcrdown::paged_simple`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::paged_simple(), output_dir = tempdir() ) # View the rendered HTML file browseURL(render_file) ## End(Not run)
Format for converting from R Markdown to an UNHCR branded Powerpoint presentation
pptx_slides(...)pptx_slides(...)
... |
extra parameters to pass to |
An R Markdown output format.
## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR PowerPoint Presentation' output: unhcrdown::pptx_slides --- ## Introduction This is an example of a UNHCR-branded PowerPoint presentation created using `unhcrdown::pptx_slides`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::pptx_slides(), output_dir = tempdir() ) ## End(Not run)## Not run: # Requires pandoc # Create an R Markdown example file rmd_content <- "--- title: 'Example UNHCR PowerPoint Presentation' output: unhcrdown::pptx_slides --- ## Introduction This is an example of a UNHCR-branded PowerPoint presentation created using `unhcrdown::pptx_slides`. " # Write the R Markdown content to a file example_file <- tempfile(fileext = ".Rmd") writeLines(rmd_content, example_file) # Render the R Markdown file rmarkdown::render(example_file, output_format = unhcrdown::pptx_slides(), output_dir = tempdir() ) ## End(Not run)