[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[](https://github.com/VisruthSK/bootstrapper/actions/workflows/test-coverage.yaml)
7<!-- badges: end -->
8
9The goal of bootstrapper is to ...
10
11## Installation
12
13You can install the development version of bootstrapper like so:
14
15``` r
16# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE?
17```
18
19## Example
20
21This is a basic example which shows you how to solve a common problem:
22
23``` r
24library(bootstrapper)
25## basic example code
26```
27
28## IMPLEMENT THIS WORKFLOW:
29
30```r
31usethis::create_package(".")
32# publish repo to GitHub
33usethis::use_readme_md()
34unlink("*.Rproj")
35usethis::use_testthat()
36
37# GitHub Actions Setup
38usethis::use_github_action("check-standard", badge = TRUE)
39usethis::use_github_action("test-coverage", badge = TRUE)
40usethis::use_github_action(
41 url = "https://github.com/visruthsk/bootstrapper/blob/main/.github/workflows/format-suggest.yaml"
42)
43usethis::use_pkgdown_github_pages()
44c(
45 "version: 2",
46 "updates:",
47 " - package-ecosystem: \"github-actions\"",
48 " directory: \"/\"",
49 " schedule:",
50 " interval: \"weekly\""
51) |>
52 write_to_path(fs::path(".github", "dependabot.yml"))
53
54find_replace_in_dir("actions/checkout@v4", "actions/checkout@v6")
55find_replace_in_dir(
56 "JamesIves/github-pages-deploy-action@v4.5.0",
57 "JamesIves/github-pages-deploy-action@v4"
58)
59
60usethis::use_tidy_description()
61# pick a license
62```