-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
77 lines (51 loc) · 2.32 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
---
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%"
)
```
# templateRpackage
<!-- badges: start -->
[](https://github.com/EcologyR/templateRpackage/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/EcologyR/templateRpackage?branch=master)
`r badger::badge_lifecycle("experimental")`
`r badger::badge_repostatus("WIP")`
<!-- `r badger::badge_codefactor("ecologyr/templaterpackage")` -->
<!-- badges: end -->
The goal of templateRpackage is to ...
## Installation
``` r
# install.packages("devtools")
devtools::install_github("EcologyR/templateRpackage")
```
The code to create this package is available [here](https://gist.github.com/Pakillo/999e34301c56011138ef164363502465).
## Example
This is a basic example which shows you how to solve a common problem:
```{r example}
# library(templateRpackage)
## basic example code
```
What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
```{r cars}
summary(cars)
```
You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this. You could also use GitHub Actions to re-render `README.Rmd` every time you push. An example workflow can be found here: <https://github.com/r-lib/actions/tree/v1/examples>.
You can also embed plots, for example:
```{r pressure, echo = TRUE, eval = FALSE}
plot(pressure)
```
In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
## Citation
If using this package, please cite it:
```{r comment=NA}
citation("templateRpackage")
```
## Funding
The development of this software has been funded by Fondo Europeo de Desarrollo Regional (FEDER) and Consejería de Transformación Económica, Industria, Conocimiento y Universidades of Junta de Andalucía (proyecto US-1381388 led by Francisco Rodríguez Sánchez, Universidad de Sevilla).
