In MangoTheCat/goodpractice: Advice on R Package Building

#, echo = FALSE, message = FALSE}
knitr::opts_chunk$set(
  echo = TRUE,
  comment = "#>",
  tidy = FALSE,
  error = FALSE,
  fig.width = 8,
  fig.height = 8)

goodpractice

Advice on R Package Building

Give advice about good practices when building R packages. Advice includes functions and syntax to avoid, package structure, code complexity, code formatting, etc.

Installation

You can install the release version from CRAN

install.packages("goodpractice")

and the development version from GitHub

pak::pak("ropensci-review-tools/goodpractice")

Usage

library(goodpractice)
gp("<my-package>")

Example

library(goodpractice)
# use example package contained in the goodpractice package
pkg_path <- system.file("bad1", package = "goodpractice")
g <- gp(pkg_path)
g

# show all available checks
# all_checks()

# run only a specific check
g_url <- gp(pkg_path, checks = "description_url")
g_url

# which checks were carried out?
checks(g_url)

# which checks failed?
failed_checks(g)

# show the first 5 checks carried out and their results
results(g)[1:5,]

License

Contributors

All contributions to this project are gratefully acknowledged using the allcontributors package following the all-contributors specification. Contributions of any kind are welcome!

Code

gaborcsardi	hfrick	mpadge	owenjonesuob	ddbortoli	KarinaMarks	olivroy
dougmet	fabian-s	noamross	MichaelChirico	fkohrt	anasimmons	andrewl776
HAlexander23	jsta	LiNk-NY	nfultz	russHyde	marberts

Issue Authors

peterhurford	stillmatic	eribul	richelbilderbeek	nathaneastwood	daroczig	mdozmorov
vdicolab	cboettig	barryrowlingson	HenrikBengtsson	kbenoit	njtierney	maelle
erleholgersen	adfi	maurolepore	jasonserviss	jackwasey	dragosmg	Bisaloo
bfgray3	wlandau	florianm	wibeasley	dpprdan	kwstat	HenningLorenzen-ext-bayer