Package 'bootstrapper'

Title: Opinionated R Package Quickstart
Description: Bootstrap new R packages with strongly opinionated defaults. Creates the package scaffold, wires up tests, README and NEWS, configures GitHub Actions and Dependabot, adds Air/Jarl setup, and drop in a default AGENTS.md for building R packages.
Authors: Visruth Srimath Kandali [aut, cre, cph] (ORCID: <https://orcid.org/0009-0005-9097-0688>)
Maintainer: Visruth Srimath Kandali <[email protected]>
License: GPL (>= 3)
Version: 1.0.0
Built: 2026-02-26 18:08:49 UTC
Source: https://github.com/VisruthSK/bootstrapper

Help Index

Bootstrap a New R Package

Description

Create a package with some opinionated setup.

Usage

bootstrapper(
  fields = getOption("usethis.description", list(`Authors@R` = person("Visruth",
    "Srimath Kandali", , "[email protected]", role = c("aut", "cre", "cph"), comment =
    c(ORCID = "0009-0005-9097-0688")))),
  setup_gha = TRUE,
  setup_dependabot = TRUE,
  setup_AGENTS = FALSE,
  setup_precommit = TRUE,
  ...
)

Arguments

fields

Named list of DESCRIPTION fields passed to usethis::create_package(). See usethis::use_description()
setup_gha

Whether to configure GitHub Actions setup.
setup_dependabot

Whether to write a Dependabot configuration.
setup_AGENTS

Whether to write a default AGENTS file.
setup_precommit

Whether to write a Bash pre-commit hook.
...

Additional arguments passed to usethis::create_package().

Value

Invisibly returns NULL.

Create a Package and Connect GitHub

Description

Create a package in root, prompts for a license, cleans up build ignore file.

Usage

create_package(fields = getOption("usethis.description"), ...)

Arguments

fields

Named list of DESCRIPTION fields passed to usethis::create_package(). See usethis::use_description()
...

Additional arguments passed to usethis::create_package().

Value

Invisibly returns NULL.

Apply Opinionated Package Setup

Description

Run the package setup steps used by bootstrapper, including test infrastructure, README/NEWS creation, GitHub Actions, and linting defaults. Run this in the root directory of your package.

Usage

pkg_setup(
  setup_gha = TRUE,
  setup_dependabot = TRUE,
  setup_AGENTS = FALSE,
  setup_precommit = TRUE
)

Arguments

setup_gha

Whether to configure GitHub Actions setup.
setup_dependabot

Whether to write a Dependabot configuration.
setup_AGENTS

Whether to write a default AGENTS file.
setup_precommit

Whether to write a Bash pre-commit hook.

Value

Invisibly returns NULL.

Configure AGENTS Defaults

Description

Copies an opinionated, concise AGENTS.md for R package development.

Usage

setup_agents()

Value

Invisibly returns NULL.

Configure Dependabot Defaults

Description

Writes a default Dependabot configuration for GitHub Actions.

Usage

setup_dependabot()

Value

Invisibly returns NULL.

Configure GitHub Actions Defaults

Description

Sets up standard GitHub Actions used by this package template and updates workflow references.

Usage

setup_gha()

Value

Invisibly returns NULL.

Configure Pre-Commit Hook

Description

Writes a Bash pre-commit hook that runs format and lint checks.

Usage

setup_precommit()

Value

Invisibly returns NULL.

Choose and Apply a License

Description

Prompts for a license choice in interactive sessions and applies the selected usethis license helper.

Usage

use_license()

Value

Invisibly returns NULL.