Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.9%) to scientific vocabulary
Last synced: 6 months ago
·
JSON representation
·
Repository
A package for package builders
Basic Info
Statistics
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
- Releases: 0
Created over 2 years ago
· Last pushed over 1 year ago
Metadata Files
Readme
Changelog
License
Citation
README.Rmd
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# packagepal
[](https://github.com/lddurbin/packagepal/actions/workflows/R-CMD-check.yaml)
[](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)
Owner
- Name: Lee Durbin
- Login: lddurbin
- Kind: user
- Location: Auckland, New Zealand
- Repositories: 3
- Profile: https://github.com/lddurbin
Citation (CITATION.cff)
# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v1.1.1
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
cff-version: 1.2.0
message: 'To cite package "packagepal" in publications use:'
type: software
license: MIT
title: 'packagepal: Guidelines and Checklists for Building CRAN-Worthy Packages'
version: 0.1.0
doi: 10.32614/CRAN.package.packagepal
abstract: Provides essential checklists for R package developers, whether you're creating
your first package or beginning a new project. This tool guides you through each
step of the development process, including specific considerations for submitting
your package to the Comprehensive R Archive Network (CRAN). Simplify your workflow
and ensure adherence to best practices with 'packagepal'.
authors:
- family-names: Durbin
given-names: Lee
email: l.d.durbin@gmail.com
repository: https://CRAN.R-project.org/package=packagepal
repository-code: https://github.com/lddurbin/packagepal
url: https://github.com/lddurbin/packagepal
contact:
- family-names: Durbin
given-names: Lee
email: l.d.durbin@gmail.com
references:
- type: software
title: cli
abstract: 'cli: Helpers for Developing Command Line Interfaces'
notes: Imports
url: https://cli.r-lib.org
repository: https://CRAN.R-project.org/package=cli
authors:
- family-names: Csárdi
given-names: Gábor
email: csardi.gabor@gmail.com
year: '2024'
doi: 10.32614/CRAN.package.cli
version: '>= 3.6.1'
- type: software
title: usethis
abstract: 'usethis: Automate Package and Project Setup'
notes: Imports
url: https://usethis.r-lib.org
repository: https://CRAN.R-project.org/package=usethis
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
orcid: https://orcid.org/0000-0003-4757-117X
- family-names: Bryan
given-names: Jennifer
email: jenny@posit.co
orcid: https://orcid.org/0000-0002-6983-2759
- family-names: Barrett
given-names: Malcolm
email: malcolmbarrett@gmail.com
orcid: https://orcid.org/0000-0003-0299-5825
- family-names: Teucher
given-names: Andy
email: andy.teucher@posit.co
orcid: https://orcid.org/0000-0002-7840-692X
year: '2024'
doi: 10.32614/CRAN.package.usethis
version: '>= 2.2.2'
- type: software
title: utils
abstract: 'R: A Language and Environment for Statistical Computing'
notes: Imports
authors:
- name: R Core Team
institution:
name: R Foundation for Statistical Computing
address: Vienna, Austria
year: '2024'
version: '>= 4.2.3'
- type: software
title: knitr
abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
notes: Suggests
url: https://yihui.org/knitr/
repository: https://CRAN.R-project.org/package=knitr
authors:
- family-names: Xie
given-names: Yihui
email: xie@yihui.name
orcid: https://orcid.org/0000-0003-0645-5666
year: '2024'
doi: 10.32614/CRAN.package.knitr
- type: software
title: rmarkdown
abstract: 'rmarkdown: Dynamic Documents for R'
notes: Suggests
url: https://pkgs.rstudio.com/rmarkdown/
repository: https://CRAN.R-project.org/package=rmarkdown
authors:
- family-names: Allaire
given-names: JJ
email: jj@posit.co
- family-names: Xie
given-names: Yihui
email: xie@yihui.name
orcid: https://orcid.org/0000-0003-0645-5666
- family-names: Dervieux
given-names: Christophe
email: cderv@posit.co
orcid: https://orcid.org/0000-0003-4474-2498
- family-names: McPherson
given-names: Jonathan
email: jonathan@posit.co
- family-names: Luraschi
given-names: Javier
- family-names: Ushey
given-names: Kevin
email: kevin@posit.co
- family-names: Atkins
given-names: Aron
email: aron@posit.co
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
- family-names: Cheng
given-names: Joe
email: joe@posit.co
- family-names: Chang
given-names: Winston
email: winston@posit.co
- family-names: Iannone
given-names: Richard
email: rich@posit.co
orcid: https://orcid.org/0000-0003-3925-190X
year: '2024'
doi: 10.32614/CRAN.package.rmarkdown
- type: software
title: testthat
abstract: 'testthat: Unit Testing for R'
notes: Suggests
url: https://testthat.r-lib.org
repository: https://CRAN.R-project.org/package=testthat
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
year: '2024'
doi: 10.32614/CRAN.package.testthat
GitHub Events
Total
Last Year
Packages
- Total packages: 1
-
Total downloads:
- cran 173 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 1
- Total maintainers: 1
cran.r-project.org: packagepal
Guidelines and Checklists for Building CRAN-Worthy Packages
- Homepage: https://github.com/lddurbin/packagepal
- Documentation: http://cran.r-project.org/web/packages/packagepal/packagepal.pdf
- License: MIT + file LICENSE
-
Latest release: 0.1.0
published over 2 years ago
Rankings
Forks count: 28.4%
Dependent packages count: 28.6%
Stargazers count: 35.0%
Dependent repos count: 35.1%
Average: 43.1%
Downloads: 88.4%
Maintainers (1)
Last synced:
7 months ago
Dependencies
.github/workflows/R-CMD-check.yaml
actions
- actions/checkout v3 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml
actions
- actions/checkout v3 composite
- actions/upload-artifact v3 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION
cran
- available >= 1.1.0 imports
- cli >= 3.6.1 imports
- usethis >= 2.2.2 imports
- utils >= 4.2.3 imports
- knitr * suggests
- rmarkdown * suggests
- testthat >= 3.0.0 suggests