fetch_biomarkers: Fetch biomarker data from the Generable API

In generable/rgeco: R package for accessing the Generable API

Fetch biomarker data from the Generable API

Description

Fetch biomarker data from the Generable API for a specific project.

Usage

fetch_biomarkers(
  project = NULL,
  project_version_id = NULL,
  measurement_name = NULL,
  annotate = T,
  annotate_doses = T,
  ...
)

Arguments

project	Project name. If NULL, defaults to value of environment variable GECO_API_PROJECT
project_version_id	Project version. If NULL, defaults to the most recent version of the project if provided, or the value of environment variable GECO_API_PROJECT_VERSION
measurement_name	Vector of measurement names to return. 'NULL' returns all measurements. Default is 'NULL'.
annotate	if 'TRUE', annotate biomarker data with dose data. Default is 'TRUE'.
annotate_doses	if 'TRUE', annotate biomarker data with timing of dose administrations. Default is 'TRUE'.
...	Optional filters applied to biomarkers data, provided as name-value pairs to limit returned values. Example: trial_id = unique(subjects$trial_id)

Details

This function retrieves biomarker data from the Generable API. It requires authentication (see login) prior to use and this pulls data from the Generable API.

Value

data.frame of biomarkers data for the project specified

Note

A project can be specified by using the project name or a specific project version.

1. If a project is specified using the name, data is fetched for the latest version of the project.

2. If a project is specified using the project version, the project name is not required.

3. If neither a project nor a project version is provided, the default project or project version is used. These are set by the environment variables GECO_API_PROJECT and GECO_API_PROJECT_VERSION

generable/rgeco documentation built on Oct. 16, 2024, 2:45 a.m.