NetBID.network.dir.create: Manipulation of Working Directories for NetBID2 Network...

In jyyulab/NetBID: Network-based Bayesian Inference of Drivers, version 2

Manipulation of Working Directories for NetBID2 Network Construction Step

Description

NetBID.network.dir.create is used to help users create an organized working directory for the network construction step in NetBID2 analysis. However, it is not essential for the analysis. It creates a hierarchcial working directory and returns a list contains this directory information.

Usage

NetBID.network.dir.create(project_main_dir = NULL, project_name = NULL)

Arguments

project_main_dir	character, name or absolute path of the main working directory.
project_name	character, name of the project folder.

Details

This function needs users to define the main working directory and the project's name. It creates a main working directory with a subdirectory of the project. It also automatically creates three subfolders (QC, DATA and SJAR) within the project folder. QC/, storing Quality Control related plots; DATA/, saving data in RData format; SJAR/, storing files needed for running SJAracne command. This function also returns a list object (example, network.par in the demo) with directory information wrapped inside. This list is an essential for network construction step, all the important intermediate data generated later will be wrapped inside.

Value

NetBID.network.dir.create returns a list object, containing main.dir (path of the main working directory), project.name (project name), out.dir (path of the project folder, which contains three subfolders), out.dir.QC, out.dir.DATA and out.dir.SJAR.

Examples

## Not run: 
# Creating a main working directory under the current working directory by folder name
network.par <- NetBID.network.dir.create("MyMainDir","MyProject")
# Or creating a main working directory under the current working directory by relative path
network.par <- NetBID.network.dir.create("./MyMainDir","MyProject")
# Or creating a main working directory to a specific path by absolute path
network.par <- NetBID.network.dir.create("~/Desktop/MyMainDir","MyProject")

## End(Not run)

jyyulab/NetBID documentation built on Dec. 23, 2024, 6:34 a.m.