-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
73 lines (53 loc) · 2.16 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
---
output: github_document
always_allow_html: yes
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
<!-- README.md is generated from README.Rmd. Please edit that file -->
# headliner
<!-- badges: start -->
[](https://github.com/zambujo/headliner/blob/master/LICENSE)
[](https://www.tidyverse.org/lifecycle/#maturing)
[](https://travis-ci.org/zambujo/headliner)
[](https://github.com/zambujo/headliner/actions)
<!-- badges: end -->
`headliner` is a package to publish headlines' data. In other words, it provides a static generator for headlines. `headliner` is ideal to quickly publish and distribute RSS feeds, for instance.
## Installation
The package is not yet on CRAN.
You can install the development version of `headliner` from github using:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("zambujo/headliner")
```
## Example
Use this example to publish the contents of a data frame:
```{r example-1, eval=FALSE}
library(headliner)
data(sciencegeist)
sciencegeist <- head(sciencegeist, 20)
headlines(sciencegeist,
title = "Sciencegeist newest posts",
save_as = "headlines.html",
layout = "card")
```
```{r thumb-1, echo=FALSE, out.width = "40%"}
knitr::include_graphics('man/figures/README-sciencegeist_html.png')
```
```{r example-2, eval=FALSE}
sciencegeist <- head(sciencegeist, 20)
headlines(sciencegeist,
title = "Sciencegeist newest posts",
save_as = "headlines.pdf")
```
```{r thumb-2, echo=FALSE, out.width = "40%"}
knitr::include_graphics('man/figures/README-sciencegeist_pdf.png')
```