https://github.com/jimbrig/pkgdev

Suite of Helpers for the R Package Developer
https://github.com/jimbrig/pkgdev

r r-package r-package-development r-stats tools utility workflow

Last synced: 3 months ago
JSON representation

Suite of Helpers for the R Package Developer

• Host: GitHub
• URL: https://github.com/jimbrig/pkgdev
• Owner: jimbrig
• License: other
• Created: 2022-02-07T21:31:37.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-03T17:07:16.000Z (6 months ago)
• Last Synced: 2024-05-12T03:32:19.141Z (6 months ago)
• Topics: r, r-package, r-package-development, r-stats, tools, utility, workflow
• Language: JavaScript
• Homepage: http://docs.jimbrig.com/pkgdev/
• Size: 4.26 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - jimbrig/pkgdev - Suite of Helpers for the R Package Developer (JavaScript)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%",

  message = FALSE,

  warning = FALSE

)

```

# R Package Developer's Toolkit - `pkgdev`

[![Codecov test coverage](https://codecov.io/gh/jimbrig/pkgdev/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jimbrig/pkgdev?branch=main)

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#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]

```r

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()`:

```R

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

3. 

***

[^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/")`.

***

Jimmy Briggs |  | 2022