createExperiment: Create an Experiment on Labstep

Description Usage Arguments Value Examples

View source: R/createExperiment.R

Description

This function allows you to create an experiment card.

Usage

1
createExperiment(user, name, description = NULL, protocolIds = NULL)

Arguments

user

A labstep user object. Must contain an 'api_key' field. Returned from 'login' command

name

The name you want to give your experiment.

description

Give your experiment a description to help you remember what it was about.

protocolIds

List of ids for protocols to attach to the experiment.

Value

Returns an 'experiment' object

Examples

1
2
3
4
5
user <- login("demo@labstep.com","demopassword")
expName = 'My First Experiment'
expDesc = 'An experiment testing the labstepR library'
experiment <- createExperiment(user,expName,expDesc)
print(experiment)

Labstep/labstepR documentation built on Jan. 30, 2020, 7:11 p.m.