pakete: Utilities for Package Development

Tools and utilities for package development currently not available from usual development tools. These are mostly linked to personal preferences during the development process. They assist in making routine and repetitive tasks easily implementable.

What does pakete do?

Currently, pakete includes functions for:

1. creating GitHub checklists for tasks in the package submission process;

2. creating CONTRIBUTING.md file;

3. adding repostatus badge; and,

4. adding Zenodo DOI badge.

Installation

You can install pakete via the Katilingban R-universe as follows:

install.packages(
  "pakete",
  repos = c('https://katilingban.r-universe.dev', 'https://cloud.r-project.org')
)

Usage

Creating GitHub issues checklist template for CRAN submissions

It is useful for some to have a checklist of tasks to be done as part of the CRAN submission process. The Releasing to CRAN chapter of the second edition of the R packages book provides good templates for tasks to do for an initial CRAN release, an update CRAN release, a submission of package to CRAN, and a post-acceptance to CRAN.

The function add_issue_template() assists in creating a GitHub issue template for your package repository for each of these stages of preparing for, submitting to, and getting accepted by CRAN. So, if you want to setup an issues checklist that you can use for preparing to submit to CRAN for an initial release, use:

library(pakete)

add_issue_template("initial-cran-release")

This will create a markdown file called initial-cran-release.md inside the .github/ISSUE_TEMPLATE directory (this will be created if it doesn’t exist yet) which is where GitHub looks for issue templates to use.

Then, once you commit and push this to your GitHub remote repository and merge it to your main branch, you will now see a choice of Initial CRAN release to use as a template whenever you open a new issue.

Creating a CONTRIBUTING.md file

If you need help with getting specific language for a CONTRIBUTING.md document in your repository, you may want to consider using the template available from this package as follows:

add_contributing(repo = "YOUR_GITHUB_USERNAME/YOUR_REPO_NAME")

This will create a CONTRIBUTING.md file within the .github directory (this will be created if it doesn’t exist). Do note that the contributing process described in this markdown document is the preferred process of those who developed the pakete package. If you are starting out and need something to use or something to build on, then this can help.

Adding a repostatus badge

If you would like to add one of the badges from repostatus to signify the development status of your project, you can do so as follows:

add_badge_status("wip")

This will add a status badge to your README file in the block where badges are usually placed.

Adding a Zenodo badge

If you use Zenodo and would like to add a Zenodo badge to your README (even if you haven’t made a release for your repository/project), you can use the add_badge_zenodo() function as follows:

add_badge_zenodo(repo = "YOUR_GITHUB_USERNAME/YOUR_REPO_NAME")

This will add a Zenodo badge to your README file in the block were badges are usually placed. Please note that whilst this can be used to add a Zenodo badge even if you haven’t made a GitHub release yet, the actual badge will only appear and the DOI assigned to your repository will only be issued once you have made your first GitHub release. Hence, you should only do this either as a post-acceptance to CRAN step when you will make your first GitHub release after your CRAN release or as part of a GitHub pre-release to activate a DOI for your repository. It would not be advisable to add this badge to your README without a GitHub release before you submit to CRAN as you will have check errors in relation to the Zenodo release URL.

Citation

If you find the pakete package useful please cite using the suggested citation provided by a call to the citation() function as follows:

citation("pakete")
#> To cite pakete in publications use:
#> 
#>   Ernest Guevarra (2024). _pakete: Utilities for Package Development_.
#>   R package version 0.0.9000, <https://katilingban.io/pakete/>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {pakete: Utilities for Package Development},
#>     author = {{Ernest Guevarra}},
#>     year = {2024},
#>     note = {R package version 0.0.9000},
#>     url = {https://katilingban.io/pakete/},
#>   }

Community guidelines

Feedback, bug reports and feature requests are welcome; file issues or seek support here. If you would like to contribute to the package, please see our contributing guidelines.

Please note that the pakete project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.