userWF: userWF

In AndersenLab/easyXpress: A Package to Read, Process, and Analyze Worm Data Generated from CellProfiler’s WormToolbox

userWF

Description

This function will flag wells based on a user provided variable in the input data.

Usage

userWF(data, ...)

Arguments

data

A data frame output from the summarizeWells or any WF functions with one or more user defined variables that are to be used as flags. Note, the varible(s) can contain multiple values or a single value if desired. The only reason to include multiple variables with a single value each is that this can preserve the order in which the flags were assigned. In some cases this may be helpful. If a user is not concerned about preserving the order in which the flags are assigned then specifying a single variable with multiple values will be sufficient to preserve the flag labels.

...

<['dynamic-dots'][rlang::dyn-dots]> Specify one or more variables a user would like to use for flagging objects. For example, <length> or <length, area>. These variables will be converted into an easyXpress compatible flags in the output data. This means it they are converted into class chr and have the _WellFlag suffix appended to their name if necessary. This way the user can supply whatever flags they like to the data and use them for downstream processing with the easyXpress framework. The order of the flags are infered from the position of the vars in the input data.

Value

A single data frame identical to the input data but with the var variable renamed to <var>_WellFlag and set to class chr if necessary.

AndersenLab/easyXpress documentation built on Dec. 6, 2024, 4:04 a.m.