[mirror] Opinionated R package quickstart
1# bootstrapper
2
3<!-- badges: start -->
4[](https://github.com/VisruthSK/bootstrapper/actions/workflows/R-CMD-check.yaml)
5[](https://app.codecov.io/gh/VisruthSK/bootstrapper)
6<!-- badges: end -->
7
8The goal of bootstrapper is to quickly setup a modern R package with appropriate actions and assorted setup. Mostly for my own usage, pretty opinionated.
9
10## Installation
11
12You can install the development version of bootstrapper like so:
13
14``` r
15pak::pak("VisruthSK/bootstrapper")
16```
17
18## Usage
19
20The package is optimized for my usage by default, so calling the main function bare is not advised unless you are me. You should call it in a directory which is already tracked by git and already has GitHub as a remote.
21
22```r
23bootstrapper::bootstrapper()
24```
25
26The main thing to set is the fields option, where you should put your own name, email, etc. instead.
27
28```r
29bootstrapper::bootstrapper(
30 fields = list(
31 "Authors@R" = person(
32 "Visruth",
33 "Srimath Kandali",
34 ,
35 "public@visruth.com",
36 role = c("aut", "cre", "cph"),
37 comment = c(ORCID = "0009-0005-9097-0688")
38 )
39 )
40)
41```
42
43There are some flags you can set to flip on/off certain features like publishing the repository as private/public on GitHub, copying over some GitHub Actions, using Dependabot for GHA, an `AGENTS.md` file, and a precommit hook for `air` and `jarl` formatting.