Skip to content

dnldelarosa/crender

Repository files navigation

crender: Conditional rendering for Rmarkdown

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. R build status Lifecycle: experimental Codecov test coverage CRAN status

Overview

The main objective of crender can be summarized as:

  1. Ability to conditionally insert content into an RMarkdown document. See Functions reference pages
  2. Ability to generate documents (in different Formats) with different content from the same RMarkdown document. See Get started section
  3. Ability to generate documents (in different Versions, same format) with different content from the same RMarkdown document. See Multiple versions - vignette

Installation

crender is not yet in CRAN.

You can install the development version from GitHub with:

tryCatch(
  library(remotes),
  error = function(e){
    install.packages('remotes')
  }
)
remotes::install_github("drdsdaniel/crender")

Roadmap

crender is an experimental stage and can suffer many changes until stable version. These are some of the ideas that at the moment I plan to add to the package. Feel free to propose any change that you consider pertinent. Look at Contributing below to see how.

However, it is important to note that we do not want to modify the knitr::knit() or Rmarkdown::render() functions unless the functionality in question is of great importance, to warrant the work that this implies.

  1. Add a function to insert conditional elements in the yaml

  2. A function to insert tables in especific formats

  3. A knit function to control additional output aspects

  4. Ability of generate multiple version with the same output format

  5. Ability of dinamically evaluate the chucks in conjunction with crender

Contributing

Have a feedback or want to contribute?

Please take a look at the contributing guidelines before filing an issue or pull request.

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


Get started

About

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages