find_runs: Find and filter runs on key features

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

Find and filter runs on key features

Description

This function is a higher-level wrapper around list_runs to aid in run discovery

Usage

find_runs(
  project = NULL,
  project_version_id = NULL,
  model_type = NULL,
  model_version = NULL,
  min_draws = 100,
  extra_fields = c()
)

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
model_type	(character vector) filter to runs with this model type, as one of: joint, survival, biomarker. NULL to disable this filter.
model_version	(character vector) filter to runs with this model version string. NULL to disable this filter.
min_draws	(scalar int) filter to runs with >= this many draws combined across all chains. NULL to disable this filter.
extra_fields	(character vector) names of additional fields to include in the summary. See results of list_datasets, list_runs, and list_models for available fields.

Details

A run is generated by a model and a dataset. This function retrieves the key features for all runs meeting certain criteria within a project version.

The returned 'data.frame' combines information about the run, model, and datasets for each run.

Authentication (see login) is required prior to using this function and this pulls the list of parameter names from the Generable API.

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

Value

a data frame with key metadata about the run.

See Also

list_runs, list_models, list_datasets, fetch_quantiles, fetch_draws

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