cytofin_read_metadata: Read in a cytofin metadata file

Description Usage Arguments Value Examples

View source: R/utils.R

Description

This function reads a cytofin metadata file from a connection that points to a .csv or a .xlsx file

Usage

1
cytofin_read_metadata(metadata_path)

Arguments

metadata_path

A filepath leading to an .xlsx or .csv file containing a table of CyTOF file (.fcs file) names. Columns should include filename, cohort, plate_number, patient_id, condition, population, and validation. TO DO: Change the names of these columns to more descriptive names and make sure that they are all actually needed. See the vignette for details: vignette("help", package = "cytofin")

Value

A data.frame containing the metadata information in the file stored at metadata_path.

Examples

1
2
3
4
5
## Not run: 
my_path <- file.path("~", "foo", "bar", "metadata.csv")
my_metadata <- cytofin:::cytofin_read_metadata(my_path)

## End(Not run)

bennyyclo/Cytofin documentation built on July 18, 2021, 8:16 a.m.