This repository was archived by the owner on Sep 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Doc: Helper Functions
kmorrisongr edited this page Feb 17, 2020
·
1 revision
fch_assert_input(fc)
- Confirm that an Fc Array data frame has only 2 groups and only one time point.
- @param fc The Fc Array data frame.
- @return A boolean determining whether the Fc Array passed inspection.
fch_covb_simple(base_measure, measure)
- @param base_measure The value for this data point at baseline
- @param measure The value for this data point at some later time point
- @return A single value: measure/base_measure
fch_fc_comb(fc, group_combs, to_comp)
- @param fc The Fc Array data frame. Must be a single time point.
- @param group_combs The group combination matrix obtained from combn(groups, 2).
- @param to_comp The column in group_combs that is to be kept.
- @return The Fc Array data frame with just the two groups in to_comp.
fch_fcs_assert_input(fcs)
- Confirm that each Fc Array in the list has only 2 groups, only one time point, and the list has been given names.
- @param fc The Fc Array data frame.
- @return A boolean determining whether the Fc Array passed inspection.
fch_geom_mean(vec)
- @param vec A vector of numeric values.
- @return A single value: the nth root of the product of vec
fch_impute_fc_time(fc, start_col, method=median)
- @param fc The Fc Array data frame, but only at a single time point.
- @param start_col Where you want the imputing to start iterating along columns from, presumably fccu_first_feat_col(fc).
- @param method For calculating imputed values. Default is median.
- @return The Fc Array data frame, with missing values replaced based on method. By default, this will be the median of a group's values for that feature.
fch_make_reag_legend(gopts)
- Add a reagant/antigen legend to a plot.
- @param gopts A list of graphical options. Must have specified the subparameters:
- gopts$reag_legend_inset The inset for the legend relative to the plot.
- gopts$reag_cats The categories for your detection reagants.
- gopts$reag_cols The colors for the detection reagant categories.
- gopts$ant_shapes The shapes for the antigens being detected.
- @return Nothing!
fch_min_max_feat(vec)
- @param vec A vector you wish to min-max z-scale.
- @return A vector of min-max z-scores.
fch_z_score(x, vec)
- @param x A single data point.
- @param vec The vector from which x derives.
- @return A single min-max z-score for x