scCustomize (version 3.0.1)

Setup_scRNAseq_Project: Setup project directory structure

Description

Create reproducible project directory organization when initiating a new analysis.

Usage

Setup_scRNAseq_Project(
  custom_dir_file = NULL,
  cluster_annotation_path = NULL,
  cluster_annotation_file_name = "cluster_annotation.csv"
)

Value

no return value. Creates system folders.

Arguments

custom_dir_file

file to file containing desired directory structure. Default is NULL and will provide generic built-in directory structure.

cluster_annotation_path

path to place cluster annotation file using Create_Cluster_Annotation_File.

cluster_annotation_file_name

name to use for annotation file if created (optional).

Examples

if (FALSE) {
# If using built-in directory structure.
Setup_scRNAseq_Project()
}