Package 'admiraldiscovery'

Title: Discover admiral Functions
Description: Package exports a function that creates an interactive gt or reactable table to help users discover the admiral functions that are used to derive ADaM variables.
Authors: Jeff Dickinson [aut, cre] (ORCID: <https://orcid.org/0009-0005-4592-1828>), Daniel D. Sjoberg [aut] (ORCID: <https://orcid.org/0000-0003-0862-2018>), Amelia H. Tran [aut] (ORCID: <https://orcid.org/0000-0002-9472-0302>)
Maintainer: Jeff Dickinson <[email protected]>
License: MIT + file LICENSE
Version: 0.6.0
Built: 2026-10-29 10:24:56 UTC
Source: https://github.com/pharmaverse/admiraldiscovery

Help Index

Report Package Versions

Description

Function returns a string listing the packages and their versions.

Usage

admiral_pkg_versions()

Examples

admiral_pkg_versions()

Admiral Function Discovery

Description

This data set lists admiral functions and links them to ADaM data sets and variables they help create.

Usage

discovery

Format

An object of class spec_tbl_df (inherits from tbl_df, tbl, data.frame) with 425 rows and 9 columns.

Find Functions with Keyword

Description

get_admiral_deprecated(): Returns tibble of all deprecated functions in the admiral, admiralonco, admiralophtha, and admiralvaccine packages.

get_admiral_superseded(): Returns tibble of all superseded functions in the admiral, admiralonco, admiralophtha, and admiralvaccine packages.

get_fns_with_keyword(): Returns a character vector of functions that have the passed keyword in the help file. For example, this function can be used to find all deprecated or superseded functions in the admiral universe, as admiral package include ⁠#' @keywords deprecated⁠ or ⁠#' @keywords superseded⁠ in the function's roxygen2 comments.

Usage

get_admiral_deprecated()

get_admiral_superseded()

get_fns_with_keyword(package, keyword, lib.loc = NULL)

Arguments

package

a character string naming an installed package.
keyword

string of the keyword to identify
lib.loc

a character vector of directory names of R libraries, or NULL. The default value of NULL corresponds to all libraries currently known. The specified library trees are used to search for package.

Value

a character vector of function names

Examples

get_admiral_deprecated()
get_admiral_superseded()
get_fns_with_keyword(package = "admiral", keyword = "superseded")

Interactive Admiral Function Discovery

Description

Interactively explore admiral functions and the ADaM data sets and variables they help create.

Usage

interactive_discovery(type = c("gt", "reactable"))

Arguments

type

type of table to return

Value

interactive gt table

Examples

interactive_discovery("gt")
interactive_discovery("reactable")

Presentation Archive

Description

This data set contains information and links to resources of recent presentations about admiral-related topics.

Usage

presentation_archive

Format

An object of class spec_tbl_df (inherits from tbl_df, tbl, data.frame) with 25 rows and 5 columns.