labguru_list_elements: Labguru list elements

In BioData/LabguruR: Labguru API wrapper for R

Labguru list elements

Description

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

Usage

labguru_list_elements(
  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 elements.
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 elements
get_cols	character(1) either 'limited' or 'all' to return a subset or all of the information regarding the elements
server	character(1) indicating the server URL
token	character(1) access token for API authentication

Value

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

Examples

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

## End(Not run)

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