list_parameter_names: List the parameter names for a run

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

List the parameter names for a run

Description

List the parameter names from the Generable API for a specific run.

Usage

list_parameter_names(
  run_id,
  project = NULL,
  project_version_id = NULL,
  include_raw = FALSE
)

Arguments

run_id	Run id; required
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
include_raw	(bool) if TRUE, include the raw parameters (on unconstrained scale) in the listing. Default FALSE

Details

A run is generated by a model and a dataset. This function retrieves the names of all parameters for a specific run as a vector. This can be used in fetch_quantiles.

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

data.frame with name, description, and submodel for each parameter exposed from the specified run

See Also

list_models, list_datasets, fetch_quantiles, fetch_draws

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