zscore_table_to_corecmotifs: Create CoRecMotifs from a table of z-score data

View source: R/04_zscore_table_to_corecmotifs.R

zscore_table_to_corecmotifsR Documentation

Create CoRecMotifs from a table of z-score data

Description

Converts a table of fluorescence z-scores into a list of CoRecMotifs.

Usage

zscore_table_to_corecmotifs(
  zscore_table,
  zscore_columns,
  array_id = NULL,
  output_file = NULL
)

Arguments

zscore_table

data.frame. An annotated table of fluorescence z-scores. See hTF_v1_annotation for expected annotation columns.

zscore_columns

character. The names of the columns of zscore_table that contain fluorescence z-scores.

array_id

character(1) or NULL. The name of the array/experiment the z-scores are from. If NULL, a random ID will be generated. (Default: NULL)

output_file

character(1) or NULL. The path to the file where the results should be saved, or NULL not to save the results. (Default: NULL)

Details

This function creates a CoRecMotif for every possible combination of the z-score columns listed in zscore_columns and the non-background probe sets that appear in the probe_set column of zscore_table. Each column listed in zscore_columns should contain data from one PBM condition, and the column name will be used to populate the pbm_condition slot of the resulting CoRecMotifs. The names of the non-background probe sets found in the probe_set column will populate the probe_set slot, and array_id (if provided) will populate the array_id slot. If no array ID is provided, a random one will be generated in the format "random_id_xxxxxxxx" where "xxxxxxxx" is replaced with a randomly generated 8 digit number. The probe_set, pbm_condition, and array_id slots will be pasted together to create a uniquely identifying name for each CoRecMotif.

Value

A list of CoRecMotifs, one for each possible combination of the probe sets in zscore_table$probe_set and the PBM conditions listed in zscore_columns.

See Also

hTF_v1_annotation for a description of the probe annotation columns.

Examples

print("FILL THIS IN")

Siggers-Lab/hTF_array documentation built on Feb. 7, 2024, 11:25 p.m.