create_project_folder {ChromSCape} | R Documentation

## Create ChromSCape project folder

### Description

Creates a project folder that will be recognizable by ChromSCape Shiny application.

### Usage

    create_project_folder(
      output_directory,
      analysis_name = "Analysis_1",
      ref_genome = c("hg38", "mm10")[1]
    )

### Arguments

`output_directory` | Path towards the directory to create the 'ChromSCape_Analyses' folder and the analysis subfolder. If this path already contains the 'ChromSCape_Analyses' folder, will only create the analysis subfolder.
`analysis_name` | Name of the analysis. Must only contain alphanumerical characters or '_'.
`ref_genome` | Reference genome, either 'hg38' or 'mm10'.

### Value

Creates the project folder and returns the root of the project.

### Examples

    dir = tempdir()
    create_project_folder(output_directory = dir,
     analysis_name = "Analysis_1")
    list.dirs(file.path(dir))

[Package ChromSCape version 1.2.62 Index]