visruth.com / bootstrapper
[mirror] Opinionated R package quickstart
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

R 95.3%
Shell 0.8%
Other 3.9%
22 2 1

Clone this repository

https://tangled.org/visruth.com/bootstrapper https://tangled.org/did:plc:xfguhlqnw7pbioeiismqdmhb/bootstrapper
git@tangled.org:visruth.com/bootstrapper git@tangled.org:did:plc:xfguhlqnw7pbioeiismqdmhb/bootstrapper

For self-hosted knots, clone URLs may differ based on your setup.

Download tar.gz
README.md

bootstrapper#

R-CMD-check Codecov test coverage

The goal of bootstrapper is to quickly setup a modern R package with appropriate actions and assorted setup. Mostly for my own usage, pretty opinionated.

Installation#

You can install the development version of bootstrapper like so:

# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE?
pak::pak("VisruthSK/bootstrapper")

Usage#

The package is optimized for my usage by default, so calling the main function bare is not advised unless you are me.

bootstrapper:bootstrapper()

The main thing to set is the fields option, where you should put your own name, email, etc. instead.

bootstrapper:bootstrapper(
  fields = list(
    "Authors@R" = person(
      "Visruth",
      "Srimath Kandali",
      ,
      "public@visruth.com",
      role = c("aut", "cre", "cph"),
      comment = c(ORCID = "0009-0005-9097-0688")
    )
  )
)

There 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.