Skip to content
To Legacy DocumentationTo Comet website
Doc version: 2.3.30

get_experiments

Get a project's experiments

Description

Either project_id should be provided, or both project_name and workspace_name should be provided. If project_id is provided, then project_name and workspace_name are ignored.

Usage

get_experiments(
  project_id = NULL,
  project_name = NULL,
  workspace_name = NULL,
  api_key = NULL,
  archived = FALSE
)

Arguments

ArgumentDescription
project_idProject ID.
project_nameProject name (can also be specified using the COMET_PROJECT_NAME parameter as an environment variable or in a comet config file).
workspace_nameWorkspace name (can also be specified using the COMET_WORKSPACE parameter as an environment variable or in a comet config file).
api_keyComet API key (can also be specified using the COMET_API_KEY parameter as an environment variable or in a comet config file).
archivedIf TRUE , retrieve archived experiments. Otherwise, retrieve active experiments.

Examples

## Not run:
 library(cometr)
# Assuming you have COMET_API_KEY, COMET_WORKSPACE, COMET_PROJECT_NAME variables defined
get_experiments() 
## End(Not run)
Sep. 19, 2023