https://github.com/inbo/INBOmd
An R package with a collection of RMarkdown styles and templates. Elaborate examples are available at https://github.com/inbo/INBOmd_examples
https://github.com/inbo/INBOmd
bookdown package r rmarkdown xelatex
Last synced: 5 months ago
JSON representation
An R package with a collection of RMarkdown styles and templates. Elaborate examples are available at https://github.com/inbo/INBOmd_examples
- Host: GitHub
- URL: https://github.com/inbo/INBOmd
- Owner: inbo
- License: gpl-3.0
- Created: 2016-08-29T08:08:33.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-08-23T14:51:21.000Z (8 months ago)
- Last Synced: 2024-11-12T18:19:38.547Z (5 months ago)
- Topics: bookdown, package, r, rmarkdown, xelatex
- Language: CSS
- Homepage: https://inbo.github.io/INBOmd
- Size: 7.63 MB
- Stars: 11
- Watchers: 8
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
- jimsghstars - inbo/INBOmd - An R package with a collection of RMarkdown styles and templates. Elaborate examples are available at https://github.com/inbo/INBOmd_examples (CSS)
README
# INBOmd 
[](https://www.repostatus.org/#active)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://github.com/inbo/inbomd/actions)
[](https://app.codecov.io/gh/inbo/inbomd?branch=main)
[](https://zenodo.org/badge/latestdoi/66824259)
INBOmd contains templates to generate several types of documents with the corporate identity of INBO or the Flemish government.
The current package has following Rmarkdown templates:
- INBO pdf_report: reports rendered to pdf, html (gitbook style) and epub
- INBO slides: presentations rendered to pdf
- INBO poster: poster rendered to a A0 pdf
- Flanders slides: presentations using the Flemish corporate identity, rendered to pdf
The templates are available in RStudio using `File` > `New file` > `R Markdown` > `From template`.
More details, including instructions for installation and usage are available at the [INBOmd website](https://inbo.github.io/INBOmd/articles/introduction.html).
## In the wild
Below are some documents created with INBOmd
1. https://inbo.github.io/inbomd_examples
1. https://doi.org/10.21436/inbor.14030462
1. https://doi.org/10.21436/inbop.14901626
1. https://pureportal.inbo.be/portal/files/12819590/rbelgium_20170307.pdf
1. https://doi.org/10.21436/inbor.12304086
## Installation
INBOmd requires a working LaTeX distribution (for conversion of markdown to pdf).
We highly recommend to use the LaTeX distribution provided by R package `tinytex`.
Close all open R sessions and start a fresh R session.
Execute the commands below.
This will install the R package `tinytex` and the `TinyTex` LaTeX distribution on your machine.
No admin rights are required.
Although `TinyTeX` is a lightweight installation, it still is several 100 MB large.
```
update.packages(ask = FALSE, checkBuilt = TRUE)
if (!"tinytex" %in% rownames(installed.packages())) {
install.packages("tinytex")
}
# install the TinyTeX LaTeX distribution
if (!tinytex:::is_tinytex()) {
tinytex::install_tinytex()
}
```
Once `TinyTeX` is installed, you need to restart RStudio.
Then you can proceed with the installation of `INBOmd`.
```
# installation from inbo.r-universe
install.packages("INBOmd", repos = "https://inbo.r-universe.dev")
## alternative: installation from github
#if (!"remotes" %in% rownames(installed.packages())) {
# install.packages("remotes")
#}
#remotes::install_github("inbo/INBOmd", dependencies = TRUE)
# add the local latex package contained in INBOmd to the TinyTeX install
tinytex::tlmgr_conf(
c("auxtrees", "add", system.file("local_tex", package = "INBOmd"))
)
# install some other needed latex packages
tinytex::tlmgr_install(c(
"inconsolata", "times", "tex", "helvetic", "dvips", "hyphen-dutch",
"hyphen-french"
))
```