https://github.com/inseefrlab/utilitr-template
Package R permettant d'encapsuler les modèles de documents pour le projet utilitR
https://github.com/inseefrlab/utilitr-template
Last synced: 9 months ago
JSON representation
Package R permettant d'encapsuler les modèles de documents pour le projet utilitR
- Host: GitHub
- URL: https://github.com/inseefrlab/utilitr-template
- Owner: InseeFrLab
- License: other
- Created: 2021-02-01T08:05:58.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T05:39:36.000Z (over 2 years ago)
- Last Synced: 2025-04-03T00:29:49.957Z (12 months ago)
- Language: CSS
- Size: 1.34 MB
- Stars: 2
- Watchers: 4
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Modèle de documents pour le projet `utilitR`
[](https://github.com/InseeFrLab/utilitr-template/actions)
[](https://github.com/InseeFrLab/utilitr-template/actions)
This package aims to simplify the formatting of [utilitR](www.book.utilitr.org)
documentation. A series of function to customize `rmarkdown` output is proposed
in this package.
An example website built using this package
can be found [here](https://awesome-volhard-d6d842.netlify.app)
You can use
```r
rmarkdown::draft('index.Rmd', template="utilitr", package="utilitr", edit = FALSE)
```
or `File > new File > R Markdown > FromTemplate > Modèle documentation utilitR`
(in that case make sure to change the `.Rmd` filename into `index.Rmd`) to
create a MWE of the output format.
You can either generate a static website or a PDF book using our package:
* Static website can be generated using `bookdown` with the following
command:
```r
bookdown::render_book("index.Rmd", output_dir = "_public", output_format = "utilitr::html_document")
```
* PDF book can be generated using our `pdf_document` function that uses
`pagedown` package under the hood:
```r
utilitr::pdf_document()
```