Get sample or assay data tables from Pluto
Source:R/experiments_data.R
pluto_get_experiment_data.Rd
Fetches the sample or assay data table for a given experiment in Pluto and returns metadata from the API request as well as the data itself
Usage
pluto_get_experiment_data(
experiment_id,
table_type,
limit = NULL,
silent = FALSE,
paginated = FALSE
)
Arguments
- experiment_id
Pluto experiment ID
- table_type
Table type, choices are "sample" or "assay"
- limit
Integer for max rows to fetch, or NULL to fetch all rows
- silent
Boolean, whether to suppress console messages
- paginated
Boolean, whether to make paginated request instead of downloading whole table, default FALSE
Value
A list containing df
, the data.frame of the requested data if it was successfully fetched, and status
, a list containing information from the Pluto API request:
status_code | HTTP status code (e.g. 200, 400, 401) |
code | String, computer-friendly code for response (e.g. authentication_failed ) |
message | Additional details |