https://github.com/lddurbin/packagepal

A package for package builders
https://github.com/lddurbin/packagepal

Last synced: 4 months ago
JSON representation

A package for package builders

• Host: GitHub
• URL: https://github.com/lddurbin/packagepal
• Owner: lddurbin
• License: other
• Created: 2023-08-04T22:31:19.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-23T20:54:52.000Z (8 months ago)
• Last Synced: 2024-08-23T22:10:19.474Z (8 months ago)
• Language: R
• Homepage:
• Size: 139 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

• jimsghstars - lddurbin/packagepal - A package for package builders (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

  out.width = "100%"

)

```

# packagepal

[![R-CMD-check](https://github.com/lddurbin/packagepal/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/lddurbin/packagepal/actions/workflows/R-CMD-check.yaml)

[![Codecov test coverage](https://codecov.io/gh/lddurbin/packagepal/graph/badge.svg)](https://app.codecov.io/gh/lddurbin/packagepal)

The goal of packagepal is to be a good pal for R package builders.

## Installation

``` r

install.packages("packagepal")

```

## Get Started

To get started with `packagepal`, simply call:

```{r package_checklist, eval=FALSE}

packagepal::checklist()

```

## Acknowledgements

This package was inspired by Building Tidy Tools, a workshop delivered by Emma Rand and Ian Lyttle at rstudio::conf(2022). Although I didn't attend this workshop myself, the slides are [freely available online](https://rstudio-conf-2022.github.io/build-tidy-tools/) and taught me how to make my first R package. I still refer to them all the time.

I have also borrowed ideas from *R Packages (2e)* by Hadley Wickham and Jennifer Bryan, as well as here: [https://github.com/DavisVaughan/extrachecks](https://github.com/DavisVaughan/extrachecks)