Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.77 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.77 KB

R-CMD-check Codecov test coverage

Welcome to rfextras!

rfextras stands for reportfactory extras. As its name suggests, it provides extensions for the {reportfactory}, a package providing a simple infrastructure for handling multiple rmarkdown documents. Unlike the reportfactory which is relatively agnostic in terms of workflows, these extensions tend to implement more opinionated tools, which may be useful only for some users.

Installing the package

To install the development version of the package, use:

remotes::install_github("reconhub/rfextras")

Overview

{rfextras} provides several features, broken down in functions meant to be used within reports, or outside.

Features to be used inside reports

Here is a quick list of features provided by {rfextras}, to be used inside .Rmd documents.

  • load_scripts(): safely loads all .R files in a given folder (defaulting to scripts/)

  • find_latest(): find the latest version of a file, when several dated versions exist (e.g. find the latest dataset)

Contributing guidelines

Contributions are welcome via pull requests.

Code of Conduct

Please note that the reportfactory project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.