-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathREADME.Rmd
81 lines (57 loc) · 2.69 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
80
---
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%"
)
library(epoxy)
```
<h1 align="center">
<a href='http://pkg.garrickadenbuie.com/epoxy/'><img src='man/figures/logo.png' align="center" height="250" alt="epoxy logo" /></a><br/>
{epoxy}
</h1>
<p align="center"><b>extra-strength <a href="https://glue.tidyverse.org">glue</a></b> for scripts, reports, and apps.</p>
<p align="center">
<!-- badges: start -->
<a href="https://CRAN.R-project.org/package=epoxy"><img src="https://www.r-pkg.org/badges/version/epoxy" alt="CRAN status" /></a>
<a href="https://gadenbuie.r-universe.dev"><img src="https://gadenbuie.r-universe.dev/badges/epoxy" alt="epoxy r-universe badge" /></a>
<a href="https://github.com/gadenbuie/epoxy/actions"><img src="https://github.com/gadenbuie/epoxy/workflows/R-CMD-check/badge.svg" alt="R-CMD-check" /></a>
<a href="https://app.codecov.io/gh/gadenbuie/epoxy?branch=main"><img src="https://codecov.io/gh/gadenbuie/epoxy/branch/main/graph/badge.svg" alt="Codecov test coverage" /></a>
<a href="https://github.com/gadenbuie/epoxy/blob/main/LICENSE.md" alt="MIT Licensed."><img src="https://img.shields.io/badge/License-MIT-blue.svg" /></a>
<!-- badges: end -->
</p>
```{r child = "man/fragments/epoxy-lead.Rmd"}
```
## epoxy in R Markdown and Quarto documents
In [R Markdown](https://rmarkdown.rstudio.com) and
[Quarto](https://quarto.org) documents,
**epoxy** gives you an `epoxy` chunk where you can write in markdown,
blending prose and data using [glue]'s template syntax.
```{r child = "man/fragments/example-movie.Rmd"}
```
Learn more about `epoxy` chunks --
and its siblings `epoxy_html` and `epoxy_latex` --
in [Getting Started](https://pkg.garrickadenbuie.com/epoxy//articles/epoxy.html).
Or read more about epoxy's inline formatting in `?epoxy_transform_inline`.
## Installation
```{r child = "man/fragments/installation.Rmd"}
```
## Setup
```{r child = "man/fragments/setup.Rmd"}
```
## Use epoxy
```{r child = "man/fragments/first-example.Rmd"}
```
## Learn more
There's a whole lot more that epoxy can do!
Learn more:
- [epoxy Package Documentation](https://pkg.garrickadenbuie.com/epoxy/)
- [Getting Started](https://pkg.garrickadenbuie.com/epoxy//articles/epoxy.html)
- [Inline Reporting with epoxy](https://pkg.garrickadenbuie.com/epoxy//articles/inline-reporting.html)
## Code of Conduct
Please note that the epoxy project is released with a [Contributor Code of Conduct](http://pkg.garrickadenbuie.com/epoxy/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.