https://github.com/dieghernan/pkgdev
A small set of functions that takes advantage of Github Actions for making your life easier as a R package developer. This package is primarily intended for personal use, however feel free to use it.
https://github.com/dieghernan/pkgdev
developer-tools experimental github-actions r r-package rstats
Last synced: 9 days ago
JSON representation
A small set of functions that takes advantage of Github Actions for making your life easier as a R package developer. This package is primarily intended for personal use, however feel free to use it.
- Host: GitHub
- URL: https://github.com/dieghernan/pkgdev
- Owner: dieghernan
- License: other
- Created: 2021-07-27T08:02:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-12T10:13:02.000Z (9 months ago)
- Last Synced: 2025-02-12T11:28:07.039Z (9 months ago)
- Topics: developer-tools, experimental, github-actions, r, r-package, rstats
- Language: R
- Homepage: https://dieghernan.github.io/pkgdev/
- Size: 88.2 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
- Citation: CITATION.cff
- Codemeta: codemeta.json
Awesome Lists containing this project
- jimsghstars - dieghernan/pkgdev - A small set of functions that takes advantage of Github Actions for making your life easier as a R package developer. This package is primarily intended for personal use, however feel free to use it. (R)
README
---
output: github_document
editor_options:
markdown:
wrap: 80
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
warning = FALSE,
message = FALSE,
tidy = "styler",
fig.path = "man/figures/README-",
dpi = 90,
out.width = "100%"
)
```
# pkgdev 
[](https://dieghernan.r-universe.dev/)
[](https://github.com/dieghernan/pkgdev/actions/workflows/check-full.yaml)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://www.codefactor.io/repository/github/dieghernan/pkgdev)
**pkgdev** is a small package that includes a set of functions that takes
advantage of [GitHub Actions (GHA)](https://github.com/features/actions) for
making your life easier as a R package developer. This package is primarily
intended for personal use, however feel free to use it (at your own risk
:wink:).
## Installation
You can install the developing version of `pkgdev` with:
```{r, eval=FALSE}
devtools::install_github("dieghernan/pkgdev")
```
Alternatively, you can install `pkgdev` using the
[r-universe](https://dieghernan.r-universe.dev/pkgdev):
```{r, eval=FALSE}
# Install pkgdev in R:
install.packages("pkgdev", repos = c(
"https://dieghernan.r-universe.dev",
"https://cloud.r-project.org"
))
```
## Example
```{r, eval=FALSE}
library(pkgdev)
gha_update_docs()
```
## Related resources
- The [tidyverse style guide](https://style.tidyverse.org/).
- **ThinkR**: [Preparing your package for a CRAN
submission](https://github.com/ThinkR-open/prepare-for-cran)
- Davis Vaughan: [extrachecks](https://github.com/DavisVaughan/extrachecks).
- **{usethis} package**: [Create a release checklist in a GitHub
issue](https://usethis.r-lib.org/reference/use_release_issue.html)
- The whole [{usethis} package](https://usethis.r-lib.org)
## Contributors
All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropensci/allcontributors) following the [allcontributors](https://allcontributors.org) specification. Contributions of any kind are welcome!
