labguru_list_folders: Labguru list folders

In BioData/LabguruR: Labguru API wrapper for R

Labguru list folders

Description

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

Usage

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

Arguments

project_id	numeric(1) The project is for which to list folders, NULL (default) returns for all projects
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 folders
get_cols	character(1) either 'limited' or 'all' to return a subset or all of the information regarding the folders
server	character(1) indicating the server URL
token	character(1) access token for API authentication

Value

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

Examples

## Not run: 
labguru_list_folders(project_id = NULL, page = 1, get_cols = "limited") # shows limited information for folders in all columns (default)

## End(Not run)

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