Skip to contents

A class to represent a sample definition object

This function updates a FlowObject with a SampleDef object created from a CSV file or a provided data frame.

Usage

SampleDef(
  x,
  sample_df = NULL,
  path = "sampledef",
  file = "sample.csv",
  group_column = "group",
  confirm = TRUE
)

Arguments

x

A FlowObject.

sample_df

Optional data frame containing the sample definitions with columns 'file' and 'group'.

path

A character string specifying the path to the directory containing the CSV file. Default is './sampledef'.

file

A character string specifying the name of the CSV file. Default is 'sample.csv'.

group_column

A character string specifying the column name for sample grouping in the CSV file.

confirm

If TRUE, prompts confirmation of editing the CSV file.

Value

A modified FlowObject containing a SampleDef object.

See also

Other Initialization: CreateFlowObject()

Examples

if (FALSE) { # \dontrun{
x <- SampleDef(x)
} # }