list_models: List models from the Generable API

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

List models from the Generable API

Description

List model attributes from the Generable API for a specific project.

Usage

list_models(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 model is used to generate a run. This function retrieves the attributes about all models within a project version with at least one run.

Authentication (see login) is required prior to using this function and this pulls the metadata 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 of model attributes for the project specified

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