list_runs: List runs from the Generable API

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

List runs from the Generable API

Description

List runs from the Generable API for a specific project.

Usage

list_runs(project = NULL, project_version_id = NULL)

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

Details

A run is generated by a model and a dataset. This function retrieves the attributes about all runs within a project version. The returned 'data.frame' contains information about what draws and quantiles are available and the model and dataset ids.

The 'run_draws' and 'run_quantiles' columns contain two named lists of 'parameter_names' and 'predictive_names'. The 'parameter_names' is a list of the parameters of the model, e.g. the sld parameters f, kg, and ks. The 'predictive_names' is a list of the predicted quantities, e.g. the predicted survival for each trial arm 'predicted_survival_per_trial_arm'.

Authentication (see login) is required prior to using this function and this pulls the metadata from the Generable API.

Value

data.frame of run attributes 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

See Also

list_models, list_datasets, fetch_quantiles, fetch_draws

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