cytofin_generate_metadata_template: Generate a template for a cytofin metadata file

In bennyyclo/Cytofin: Integrate CyTOF Datasets From Heterogeneous Sources

Description

cytofin_generate_metadata_template creates a template metadata .csv file (with the correct columns and dummy example data) in a specified location.

Usage

cytofin_generate_metadata_template(
  file_name = "template_metadata.csv",
  template_path = getwd()
)

Arguments

file_name	A string representing the name of the .csv file to be saved in the directory specified by template_path. Defaults to "template_metadata.csv"
template_path	A file path or connection where the template file should be written. Defaults to the current working directory

Examples

# specify the path where you'd like to store the template file
my_name <- "metadata_template.csv"
my_path <- file.path("~", "Desktop", "template_folder")
    

# generate the template file, which then can be edited manually 
cytofin_generate_metadata_template(
   file_name = my_name, 
   template_path = my_path
)

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