annotate_fluorescence_table: Annotate fluorescence data

In Siggers-Lab/hTF_array: Process and Visualize CoRec Data

Annotate fluorescence data

Description

Adds probe information to a table of fluorescence data from a CoRec experiment.

Usage

annotate_fluorescence_table(
  fluorescence_table,
  fluorescence_columns,
  annotation,
  output_file = NULL
)

Arguments

fluorescence_table	data.frame. A table of fluorescence values.
fluorescence_columns	character. The names of the columns of fluorescence_table that contain fluorescence data.
annotation	data.frame. The probe annotations to add to the fluorescence table. See hTF_v1_annotation for expected annotation columns.
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

The fluorescence data table must have a column named probe_id. The remaining column names must match the names listed in fluorescence_columns. Any additional columns will be dropped.

See hTF_v1_annotation for a description of the expected columns of the annotation table. Any additional columns will be dropped.

The IDs in the probe_id column in the annotation table must match the IDs in the probe_id column of the fluorescence table. IDs that are present in the annotation table but not the fluorescence table will be dropped silently. IDs that are present in the fluorescence table but not the annotation table will be dropped with a warning.

Value

A data frame of fluorescence values and the corresponding probe information. See hTF_v1_annotation for a description of the probe annotation 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.