https://github.com/ropensci-review-tools/goodpractice
Advice on R Package Building
https://github.com/ropensci-review-tools/goodpractice
Last synced: 5 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 (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T12:41:37.000Z (11 months ago)
- Last Synced: 2024-06-11T16:08:16.651Z (11 months ago)
- Language: R
- Homepage: https://docs.ropensci.org/goodpractice/
- Size: 473 KB
- Stars: 427
- Watchers: 16
- Forks: 35
- Open Issues: 39
-
Metadata Files:
- Readme: README.Rmd
- 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,]
```## License
MIT © 2024 rOpenSci
## 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
