labguru_add_experiment: Labguru add experiment

View source: R/experiment.R

labguru_add_experimentR Documentation

Labguru add experiment

Description

Add a new experiment to labguru

Usage

labguru_add_experiment(
  title,
  project_id,
  folder_id,
  description = NULL,
  return = "id",
  server = Sys.getenv("LABGURU_SERVER"),
  token = Sys.getenv("LABGURU_TOKEN")
)

Arguments

title

character(1) The title of the experiment

project_id

numeric(1) The project id for which to add a new experiment

folder_id

numeric(1) The folder id for which to add a new experiment

description

character(1) The description of the experiment

return

character(1) whether the function returns either 'id' (default) or 'all' experiment information

server

character(1) indicating the server URL

token

character(1) access token for API authentication

Value

list with either experiment id only or all experiment information

Examples

## Not run: 
labguru_add_experiment(project_id  = 1,
                       title       = "My new experiment",
                       description = "This experiment contains ...")

## End(Not run)

BioData/LabguruR documentation built on May 11, 2022, 11:46 p.m.