cccmdown

The goal of {cccmdown} is to ease and speed up the creation of reports following the CCCM brand identity.

Installation

Get started by installing the {cccmdown} package from GitHub using the {pak} library:

# If pak is not yet installed, uncomment the following line:
# install.packages("pak")

pak::pkg_install("unhcr-dataviz/cccmdown")

Usage

The {cccmdown::paged_report} template is designed for R Markdown projects, simply put the following code in your R Markdown header. For example:

---
title: "CCCM report"
date: "20 September 2023"
output:
  cccmdown::paged_report:
    coord_mec: "cluster"
    country: "Country name"
---

You can also open a {cccmdown::paged_report} template using RStudio:

1. Click the “File” menu then “New File” and choose “R Markdown”.
2. In the “From Template” tab, choose the CCCM Paged built-in template.

Acknowledgements

We extend our gratitude to the creators of the {pagedown} package that influenced the development of {cccmdown}.

Contribution

Contributions to {cccmdown} are highly valued. If you have suggestions, uncover bugs, or envision new features, kindly submit an issue on GitHub. To contribute code, don’t hesitate to fork the repository and create a pull request.

License

This package is distributed under the MIT License.