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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
# use_readme_md() has expected form for a non-GitHub package
Code
writeLines(read_utf8("README.md"))
Output
# {TESTPKG}
<!-- badges: start -->
<!-- badges: end -->
The goal of {TESTPKG} is to ...
## Installation
You can install the development version of {TESTPKG} like so:
``` r
# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE?
```
## Example
This is a basic example which shows you how to solve a common problem:
``` r
library({TESTPKG})
## basic example code
```
# use_readme_md() has expected form for a GitHub package
Code
writeLines(read_utf8("README.md"))
Output
# {TESTPKG}
<!-- badges: start -->
<!-- badges: end -->
The goal of {TESTPKG} is to ...
## Installation
You can install the development version of {TESTPKG} from [GitHub](https://github.com/) with:
``` r
# install.packages("pak")
pak::pak("OWNER/TESTPKG")
```
## Example
This is a basic example which shows you how to solve a common problem:
``` r
library({TESTPKG})
## basic example code
```
# use_readme_rmd() has expected form for a non-GitHub package
Code
writeLines(read_utf8("README.Rmd"))
Output
---
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%"
)
```
# {TESTPKG}
<!-- badges: start -->
<!-- badges: end -->
The goal of {TESTPKG} is to ...
## Installation
You can install the development version of {TESTPKG} like so:
``` r
# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE?
```
## Example
This is a basic example which shows you how to solve a common problem:
```{r example}
library({TESTPKG})
## 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 can also embed plots, for example:
```{r pressure, echo = FALSE}
plot(pressure)
```
In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
# use_readme_rmd() has expected form for a GitHub package
Code
writeLines(read_utf8("README.Rmd"))
Output
---
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%"
)
```
# {TESTPKG}
<!-- badges: start -->
<!-- badges: end -->
The goal of {TESTPKG} is to ...
## Installation
You can install the development version of {TESTPKG} from [GitHub](https://github.com/) with:
``` r
# install.packages("pak")
pak::pak("OWNER/TESTPKG")
```
## Example
This is a basic example which shows you how to solve a common problem:
```{r example}
library({TESTPKG})
## 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 can also embed plots, for example:
```{r pressure, echo = FALSE}
plot(pressure)
```
In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
|
