blob: 589ac6fa3e3a96d10b3d06d1b2a6858752fc33de (
plain)
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
|
<!-- README.md is generated from README.Rmd. Please edit that file -->
# rcsobczak
<!-- badges: start -->
<!-- badges: end -->
The goal of rcsobczak is to easily provide convenience functions I find
useful.
## Installation
You can install the development version of rcsobczak like so:
``` r
# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE?
install.packages('pak')
pak::pkg_install('git::https://codeberg.org/csobczak/csobczak.r')
```
## Example
This is a basic example which shows you how to solve a common problem:
``` r
library(rcsobczak)
## basic example code
```
What is special about using `README.Rmd` instead of just `README.md`?
You can include R chunks like so:
``` r
summary(cars)
#> speed dist
#> Min. : 4.0 Min. : 2.00
#> 1st Qu.:12.0 1st Qu.: 26.00
#> Median :15.0 Median : 36.00
#> Mean :15.4 Mean : 42.98
#> 3rd Qu.:19.0 3rd Qu.: 56.00
#> Max. :25.0 Max. :120.00
```
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:
<img src="man/figures/README-pressure-1.png" alt="" width="100%" />
In that case, don’t forget to commit and push the resulting figure
files, so they display on GitHub and CRAN.
|
