https://github.com/unhcr-dataviz/unhcrdown
UNHCR branded R Markdown templates for reports, presentations, and web documents
https://github.com/unhcr-dataviz/unhcrdown
pagedown rmarkdown rmarkdown-template xaringan
Last synced: 4 months ago
JSON representation
UNHCR branded R Markdown templates for reports, presentations, and web documents
- Host: GitHub
- URL: https://github.com/unhcr-dataviz/unhcrdown
- Owner: unhcr-dataviz
- License: other
- Created: 2021-09-15T19:05:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-17T13:00:53.000Z (over 1 year ago)
- Last Synced: 2025-10-22T05:43:54.040Z (8 months ago)
- Topics: pagedown, rmarkdown, rmarkdown-template, xaringan
- Language: SCSS
- Homepage: https://unhcr-dataviz.github.io/unhcrdown/
- Size: 18.3 MB
- Stars: 24
- Watchers: 4
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# unhcrdown 
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://github.com/unhcr-dataviz/unhcrdown/actions/workflows/R-CMD-check.yaml)
[](https://CRAN.R-project.org/package=unhcrdown)
Streamline your document creation process with the `{unhcrdown}` R package. It provides a comprehensive set of templates designed to align your reports and presentations with **UNHCR's brand guidelines**. This package offers ready-to-use R Markdown templates for various document types, ensuring consistent UNHCR visual identity across your communications.
## Features
- A collection of professional templates following UNHCR brand guidelines
- Ready-to-use formats for reports, presentations, and websites
- Easy-to-use functions that work seamlessly with R Markdown
- Consistent styling across all document types
## Installation
Get started by installing the `{unhcrdown}` package from CRAN with:
```{r install, eval=FALSE}
install.packages("unhcrdown")
```
Or retrieve the development version from Github using the `{pak}` package:
```{r pak, eval=FALSE}
# If pak is not yet installed, uncomment the following line:
# install.packages("pak")
pak::pkg_install("unhcr-dataviz/unhcrdown")
```
## Usage
The `{unhcrdown}` templates are designed for R Markdown projects, any of the available format can simply be added to `output` parameter of the R Markdown `yaml` header. For example:
```{yaml}
---
title: "UNHCR Branded Report"
author: "First Last Name"
date: "`r Sys.Date()`"
output: unhcrdown::paged_report
---
```
### Available Formats
- **PDF Reports**: Two HTML to PDF options:
```{yaml}
output: unhcrdown::paged_report # Full template with cover
# or
output: unhcrdown::paged_simple # Streamlined version
```
- **Word Documents**: Professional reports using `officedown::rdocx_document`
```{yaml}
output: unhcrdown::docx_simple
```
- **PowerPoint**: Presentation slides
```{yaml}
output: unhcrdown::pptx_slides
```
- **HTML Slides**: Web presentations
```{yaml}
output: unhcrdown::html_slides
```
- **HTML Page**: Web based documents
```{yaml}
output: unhcrdown::html_page
```
### RStudio Integration
Create new documents directly from RStudio:
1. File → New File → R Markdown
2. Select "From Template"
3. Choose any `{unhcrdown}` template
```{r child="man/rmdfragments/unhcr_tools.Rmd"}
```
## Acknowledgements
We extend our gratitude to the creators of the [`pagedown`](https://github.com/rstudio/pagedown) package that influenced the development of `unhcrdown`.
## Contribution and Code of Conduct
Contributions to `{unhcrdown}` are highly valued. To ensure a welcoming and inclusive community, we follow our [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). If you have suggestions, uncover bugs, or envision new features, kindly submit an [issue on GitHub](https://github.com/unhcr-dataviz/unhcrdown/issues).
## License
This package is distributed under the [MIT License](https://github.com/unhcr-dataviz/unhcrdown/blob/master/LICENSE.md).