bf_standards: Handle community standard protocols

In bitfield: Handle Bitfields to Record Meta Data

Handle community standard protocols

Description

This function allows the user to list, pull or push bit-flag protocols to the bitfloat/standards repository on github

Usage

bf_standards(
  protocol = NULL,
  remote = NULL,
  action = "list",
  version = "latest",
  change = NULL,
  token = NULL
)

Arguments

protocol	character(1) name of the bit-flag protocol to handle. This is either used to filter the list retrieved from remote, the name of the protocol to pull from github, or the name of the new protocol that should be pushed to github.
remote	character(1) the path in the repo, where the protocol is stored or shall be stored. For instance, to store a protocol in https://github.com/bitfloat/standards/distributions/type/distType.yml, this should be "distributions/type".
action	character(1) whether to push or pull a protocol, or list the remote contents.
version	character(1) version tag for the protocol, must have a semantic versioning pattern, i.e., MAJOR.MINOR.PATCH.
change	character(1) in case you try to push an updated version of a protocol, you must provide a brief description of what has changed from the current version to this version.
token	character(1) your github personal access token (PAT).

Details

Create a Personal Access Token in your github developer settings (or by running usethis::create_github_token()) and store it with gitcreds::gitcreds_set(). The token must have the scope 'repo' so you can authenticate yourself to pull or push community standards, and will only be accessible to your personal R session.

Value

description

Examples

## Not run: 
# list all currently available standards
bf_standards()

## End(Not run)

bitfield documentation built on June 9, 2025, 5:09 p.m.