`{rpt}` (R package template)

The goal of {rpt} is to …

Installation

You can install the development version of {rpt} from GitHub with:

# install.packages("pak")
pak::pak("UCD-SERG/rpt")

Example

This is a basic example which shows you how to solve a common problem:

library(rpt)
## basic example code

Development

Building the Documentation Site

This package uses altdoc with Quarto to build its documentation site. To build and preview the documentation locally:

# Load the package
pkgload::load_all()

# Render the documentation
altdoc::render_docs()

# Preview the site
altdoc::preview_docs()

The documentation is automatically built and deployed to GitHub Pages via GitHub Actions when changes are pushed to the main branch.

Other R Package Template Options

If you’re looking for alternative R package templates, you may also want to consider:

r.pkg.template - A comprehensive R package template from Insights Engineering

Code of Conduct

Please note that the {rpt} project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Code Links