labguru_list_experiment_procedures: Labguru list experiment_procedures

View source: R/experiment_procedures.R

labguru_list_experiment_proceduresR Documentation

Labguru list experiment_procedures

Description

This function returns information of the available experiment procedures in a data frame.

Usage

labguru_list_experiment_procedures(
  experiment_id = NULL,
  page = 1,
  get_cols = "limited",
  server = Sys.getenv("LABGURU_SERVER"),
  token = Sys.getenv("LABGURU_TOKEN")
)

Arguments

experiment_id

numeric(1) The experiment id for which to list experiment procedures.

page

numeric(1) representing the page number of data to request. Limited data can be return in 1 request, incrementally try higher page numbers for more experiments

get_cols

character(1) either 'limited' or 'all' to return a subset or all of the information regarding the experiment procedures

server

character(1) indicating the server URL

token

character(1) access token for API authentication

Value

dataframe with information of experiment procedures, NULL if no experiment procedures were available for the request

Examples

## Not run: 
# The following example shows limited information for experiments in all experiments (default)
labguru_list_experiment_procedures(experiment_id = NULL, 
                                   page          = 1, 
                                   get_cols      = "limited")

## End(Not run)

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