Package 'r4sub'

Title: Easily Install and Load the R4SUB Ecosystem
Description: The 'r4sub' package is a meta-package that installs and loads core packages of the R4SUB (R for Regulatory Submission) clinical submission readiness ecosystem. Loading 'r4sub' attaches 'r4subcore', 'r4subtrace', 'r4subscore', 'r4subrisk', 'r4subdata', and 'r4subprofile'.
Authors: Pawan Rama Mali [aut, cre, cph] (ORCID: <https://orcid.org/0000-0001-7864-5819>)
Maintainer: Pawan Rama Mali <[email protected]>
License: MIT + file LICENSE
Version: 0.1.0
Built: 2026-05-16 07:03:48 UTC
Source: https://github.com/r4sub/r4sub

Help Index

Core R4SUB packages

Description

Returns the names of the R4SUB packages that are automatically attached when library(r4sub) is called.

Usage

core_packages()

Value

A character vector of package names.

Examples

core_packages()

Cite the R4SUB Ecosystem

Description

Prints citation information for the R4SUB ecosystem and each installed core package. Use this when citing R4SUB tools in a regulatory submission document, scientific paper, or validation report.

Usage

r4sub_cite(package = NULL)

Arguments

package

Character. Name of a specific R4SUB package to cite. If NULL (default), cites all installed core packages plus the meta-package.

Value

Invisibly returns a named list of citation objects, one per package. Called for its side effect of printing citation information to the console.

Examples

r4sub_cite()
r4sub_cite("r4subcore")

Show R4SUB Function Conflicts

Description

Reports any exported function name collisions between attached R4SUB packages and other loaded packages.

Usage

r4sub_conflicts()

Value

A tibble with columns: func, r4sub_package, other_package. Returned invisibly. Prints conflicts if any exist.

Examples

r4sub_conflicts()

Show R4SUB Ecosystem News

Description

Prints the NEWS entries for each installed R4SUB ecosystem package. Useful for tracking what has changed across the ecosystem after updating.

Usage

r4sub_news(package = NULL)

Arguments

package

Character. Name of a specific R4SUB package to show news for. Must be one of the core R4SUB packages. If NULL (default), shows news for all installed core packages.

Value

Invisibly returns a named list of news database objects, one per package. Called for its side effect of printing NEWS entries to the console.

Examples

r4sub_news()
r4sub_news("r4subcore")

List R4SUB Ecosystem Packages

Description

Returns a tibble of all R4SUB packages with their installed version and current attachment status.

Usage

r4sub_packages(include_self = TRUE)

Arguments

include_self

Logical. If TRUE (default), includes the r4sub meta-package itself in the listing.

Value

A tibble with columns: package, version, attached.

Examples

r4sub_packages()

Check R4SUB Package Installation Status

Description

Reports the installed version of each R4SUB ecosystem package and highlights any packages that are not installed.

Usage

r4sub_status()

Value

A tibble with columns: package, installed. Returned invisibly. Called for its side effect of printing installation status to the console.

Examples

r4sub_status()