Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.73 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.73 KB
Raw

R Package Developer’s Toolkit - pkgdev

Codecov test coverage Lifecycle: experimental

The goal of pkgdev is to provide the R Package Developer a suite of tools to simplify and aid the various processes involved with creating, developing, testing, maintaining, and overall management of their R Packages.

Installation

You can install the development version of pkgdev with pak like so: 1

pak::pak("jimbrig/pkgdev")

Usage

pkgdev comes with many tools out-of-the-box for package developer’s in R to quickly get started:

Create a new package

To create a new R package locally, run pkgdev::create_pkg():

pkgdev::create_pkg("myawesomepkg", pkgdevt_script = TRUE, github = TRUE)

This will perform the following steps:

  1. Create a new directory called myawesomepkg
  2. Initialize an RStudio project, myawesomepkg.Rproj, within that directory

Jimmy Briggs | jimmy.briggs@jimbrig.com | 2022

Footnotes

  1. Similarly, you can install the package using the more common devtools::install_github() and remotes::install_github(). If you need to install pak, install the development version using install.packages("pak", repos = "https://r-lib.github.io/p/pak/devel/"). ↩