Description Usage Arguments Value
View source: R/cytofin_prep_anchors.R
This function calculates reference statistics needed for CytofIn batch normalization.
Specifically, it calculates the universal mean and universal variance vectors
of the generalized anchors identified in the metadata file at metadata_path
;
in addition, it calculates the non-channel-specific bulk mean and bulk variance
of the generalized anchors.
1 2 3 4 5 6 7 8 9 | cytofin_prep_anchors(
metadata_path,
panel_path,
input_data_path,
input_prefix = "homogenized_",
output_path = "none",
shift_factor = 0,
scale_factor = 0.2
)
|
metadata_path |
A file path leading to an .xlsx or .csv file
containing a table of CyTOF file (.fcs file) names. Columns should include
See the vignette for details: |
panel_path |
A file path leading to an .xlsx or .csv file containing
a table of standardized antigen panel information. Columns should include
See the vignette for details: |
input_data_path |
A folder directory containing the input CyTOF files
to be prepped for normalization. These files should already be homogenized,
and in most cases this will be the directory to which the output
.fcs files from |
input_prefix |
The string that was appended to the name of the input files
of |
output_path |
A file path specifying where to save the output .rds file containing the statistics calculated from this step and the concatenated .FCS files containing all cells from the generalized anchor samples. Defaults to "none", in which case no files are saved. |
shift_factor |
The scalar value
Defaults to 0. |
scale_factor |
The scalar value
Defaults to 0.2. |
a list()
of summary statistics with the following elements:
universal_var: a named numeric vector in which each entry corresponds to the universal variance of an antigen channel in the homogenized dataset
universal_mean: a named numeric vector in which each entry corresponds to the universal mean of an antigen channel in the homogenized dataset
bulk_var: The mean of all the channel-specific universal variances
in universal_var
(a scalar value)
bulk_mean: The mean of all the channel-specific universal means
in universal_mean
(a scalar value)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.