Package 'pakete'

Title: Utilities for Package Development
Description: 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.
Authors: Ernest Guevarra [aut, cre, cph]
Maintainer: Ernest Guevarra <[email protected]>
License: GPL (>= 3)
Version: 0.2.0.9000
Built: 2025-02-09 06:16:12 UTC
Source: https://github.com/katilingban/pakete

Help Index

Add badges to README

Description

Add badges to README

Usage

add_badge_status(
  status = c("concept", "wip", "suspended", "abandoned", "active", "inactive",
    "unsupported", "moved"),
  path = NULL,
  .url = NULL
)

add_badge_codefactor(repo = NULL, path = NULL)

add_badge_zenodo(repo = NULL, path = NULL)

Arguments

status

A character value for status to be assigned to project. This can be either "concept", "wip", "suspended", "abandoned", "active", "inactive", "unsupported", or "moved".
path

Path to file to add repostatus badge to. Set to NULL by default which would indicate that a README file in the root directory of the project is the target file.
.url

If status is "moved", the URL to which the repository has moved to. Otherwise NULL.
repo

Short remote git repository name. If NULL, is determined based on current git settings.

Value

An entry to the badge section of the README of the repository. Otherwise, a print of the markdown text for the status badge.

Examples

if (FALSE) {
  add_badge_status("wip")
  add_badge_codefactor(repo = "katilingban/pakete")
  add_badge_zenodo(repo = "katilingban/pakete")
}

Add contributing markdown

Description

Add contributing markdown

Usage

add_contributing(repo = NULL, overwrite = FALSE)

Arguments

repo

Short remote git repository name. If NULL, is determined based on current git settings.
overwrite

Logical. Should an existing CONTRIBUTING.md file be overwritten? Default to FALSE.

Value

A CONTRIBUTING.md file in the .github directory

Examples

if (FALSE) add_contributing("katilingban/pakete")

Add GitHub Actions

Description

Add GitHub Actions

Usage

add_github_action(gha_name = NULL, overwrite = FALSE)

Arguments

gha_name

Short name of GitHub Action to add. Currently supports GitHub Action for Netlify deployment of testing version of pkgdown website ("netlify").
overwrite

Logical. Should an existing GitHub Action be overwritten? Default is FALSE.

Value

A GitHub Action YAML file of the specified workflow to be added in .github/workflows directory.

Examples

if (FALSE) add_github_action(gha_name = "netlify")

Add issue templates

Description

Add issue templates

Usage

add_issue_template(
  issue = NULL,
  path = ".github/ISSUE_TEMPLATE",
  overwrite = FALSE
)

Arguments

issue

A character value of type of issue template to create. Choices are "initial-cran-release", "update-cran-release", "submission-cran", and "acceptance-cran".
path

Path to file to add issue template into. Set to ".github/ISSUE_TEMPLATE" which is the default location specified by GitHub.
overwrite

Logical. If an existing issue template with the same file name is found, should it be overwritten? Default to FALSE.

Value

A specified issue template markdown file in the specified path.

Examples

if (interactive()) add_issue_template("initial-cran-release")