SPADE-class: S4 SPADE Class

In CytobankAPI: Cytobank API Wrapper for R

S4 SPADE Class

Description

A SPADE object that holds pertinent SPADE advanced analysis run information. This class should never be called explicitly. If a user would like to create a new Cytobank SPADE object, utilize the spade.new function, or any other SPADE endpoints that return SPADE objects documented in the 'Details' section.

Value

A SPADE advanced analysis object

Slots

created_experiment

numeric representing the experiment that gets created from the SPADE analysis

down_sampled_events_target

numeric representing the percent OR absolute number (depends on 'down_sampled_events_type' slot) for downsampling occurring within the SPADE analysis, learn more about SPADE density-dependent downsampling

down_sampled_events_type

character representing the downsampling type for down_sampled_events_target, learn more about SPADE density-dependent downsampling types - choose one of the following : ("percent" [default], "absolute_number")

fold_change_groups

dataframe representing the fold change groups within a SPADE analysis, learn more about SPADE fold change groups

population_id

numeric representing the population to run the SPADE analysis on, learn more about choosing a population for SPADE

spade_id

numeric representing the SPADE analysis ID

target_number_nodes

numeric representing how many population nodes SPADE will seek out within the given data, learn more about target number of nodes for SPADE

CytobankAPI documentation built on April 21, 2023, 9:08 a.m.