-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
79 lines (57 loc) · 3.74 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# ovpaged
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://codecov.io/gh/openvolley/ovpaged?branch=master)
[](https://github.com/openvolley/ovpaged/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
Pagedown templates for the Openvolley project. Inspiration taken (and some code borrowed) from [pagedown](https://github.com/rstudio/pagedown/), [pagedreport](https://github.com/rfortherestofus/pagedreport/).
Features:
- automatically breaks long tables across pages, with table headers repeated on each new page
## Installation
```{r eval=FALSE}
options(repos = c(openvolley = "https://openvolley.r-universe.dev",
CRAN = "https://cloud.r-project.org"))
install.packages("ovpaged")
## or
## install.packages("remotes") ## if needed
remotes::install_github("openvolley/ovpaged")
```
## Usage
YAML options:
```yml
---
title: "Title of the report"
output:
ovpaged::simple:
toc: false
auto_table_breaks: true
striped: true
---
```
Additional YAML options:
```yml
subtitle: "Subtitle of the report"
author: "Author Name"
date: "`r knitr::inline_expr("Sys.Date()")`"
google-font: true
main-font: EB Garamond
header-font: Architects Daughter
base-font-size: 18pt
header-image: "`r knitr::inline_expr("knitr::image_uri(my_image_file)")`"
header-background-colour: red
header-title: Title for the header block
```
Include `google-font: true` if `main-font` and `title-font` are Google fonts.