Learn R Programming

gofigR (version 1.1.3)

find_analysis: Find an analysis by name, optionally creating it.

Description

Searches the analyses within a workspace by name and, optionally, creates a new analysis when no match is found.

Usage

find_analysis(gf, name, description = NULL, workspace = NULL, create = FALSE)

Value

An analysis object corresponding to the matching (or newly created) analysis.

Arguments

gf

GoFigr client.

name

Name of the analysis to find.

description

Optional description to assign if a new analysis is created.

workspace

Parent workspace (object or API ID). If `NULL`, the client's default workspace is used.

create

Logical; if `TRUE` and the analysis does not exist, a new one is created. If `FALSE`, an error is thrown when no matching analysis is found.