https://github.com/ropensci-review-tools/goodpractice
Advice on R Package Building
https://github.com/ropensci-review-tools/goodpractice
Last synced: 3 months ago
JSON representation
Advice on R Package Building
- Host: GitHub
- URL: https://github.com/ropensci-review-tools/goodpractice
- Owner: ropensci-review-tools
- License: other
- Created: 2016-01-31T16:46:37.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-07-01T11:48:17.000Z (3 months ago)
- Last Synced: 2025-07-04T01:50:31.735Z (3 months ago)
- Language: R
- Homepage: https://docs.ropensci.org/goodpractice/
- Size: 541 KB
- Stars: 468
- Watchers: 14
- Forks: 36
- Open Issues: 31
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
- Codemeta: codemeta.json
Awesome Lists containing this project
- jimsghstars - ropensci-review-tools/goodpractice - Advice on R Package Building (R)
README
---
output: github_document
---
```{r, setup, include = FALSE}
#, echo = FALSE, message = FALSE}
knitr::opts_chunk$set(
echo = TRUE,
comment = "#>",
tidy = FALSE,
error = FALSE,
fig.width = 8,
fig.height = 8)
```
# goodpractice 
[](https://github.com/ropensci-review-tools/goodpractice/actions)
[](https://CRAN.R-project.org/package=goodpractice)
[](https://www.r-pkg.org/pkg/goodpractice)
[](https://app.codecov.io/gh/ropensci-review-tools/goodpractice?branch=main)
## 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
```{r eval = FALSE}
install.packages("goodpractice")
```
and the development version from GitHub
```{r eval = FALSE}
pak::pak("ropensci-review-tools/goodpractice")
```
## Usage
```r
library(goodpractice)
gp("")
```
## Example
```{r, message = FALSE, warning = FALSE}
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,]
```
## Contributing
We welcome any and all contributions to this package.
See [CONTRIBUTING.md](https://docs.ropensci.org/goodpractice/CONTRIBUTING.html) for details.
## License
MIT © 2022 Ascent Digital Services UK Limited
## Contributors
All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropensci/allcontributors) following the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome!
### Code
### Issue Authors
### Issue Contributors
