CytobankAPI (version 2.2.0)

helper_functions: Helper Functions

Description

Various helper functions to utilize within the Cytobank API.

Usage

helper.filter_names_to_ids_from_df(ids_names_df, names_array = c("*"))
helper.channel_ids_from_long_names(
  panels_list,
  long_channel_names,
  fcs_files = c()
)

Arguments

ids_names_df

dataframe containing both IDs and their associated names

names_array

vector or list of character regular expressions to use

panels_list

list provided from the panels.list endpoint

long_channel_names

vector of character representing long channel names

fcs_files

vector of integers representing a list of FCS file IDs

Details

helper.filter_names_to_ids_from_df Compile a vector of IDs from an array of regular expressions.

helper.channel_ids_from_long_names Compile a vector of IDs based on long channel names for specific FCS files from an experiment. If no FCS files are provided, IDs will be retrieved based on unique short channel / long channel combinations across all FCS files.

Examples

if (FALSE) helper.filter_names_to_ids_from_df(id_and_names_dataframe,
names_list=c("CD.*", "Time", "pp38"))

if (FALSE) helper.channel_ids_from_long_names(panels.list(cyto_session, 22),
  long_channel_names=c("long_channel1", "long_channel2"), fcs_files=c(1,2,3,4,5))