Skip to content

Commit d4709e6

Browse files
authored
Update README.md
1 parent 4cb9678 commit d4709e6

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11

22

33
## tuMap package installation and code requirements
4-
The tuMap package is attached to this tutorial as .tar.gz file and can be installed from source. For this, download the .tar.gz file and follow the code below.
4+
tuMap package can be downloaded from github. Please make sure you have the devtools package installed prior to tuMap installation.
5+
56
We provide a .R script that includes the required functions to run this code *funcTutorial.R* (located in the "tutorialCode" directory). This script includes detailed documentation about the functions used by this script, apart of the ones that are implemented in the tuMap package. In addition, it includes the required packages for running the script (including: ggplot2, pheatmap, stringr, Biobase, reshape2, cellAlign, glmnet, survival, survAUC, survminer, psupertime, caret, flowCore, SingleCellExperiment, and emdist). We thus recommend to source this script before running the code.
67
Please download all the files located in the "Data" directory maintaining their internal hierarchy. In the following code, we will treat the directory where the data is placed as "dataDir", whose path should be defined in the below script.
78
In order to run only the tuMap algorithm on your samples without replicating the whole code for the AML CyTOF dataset, please follow the section entitled: "Application of the tuMap algorithm on the AML samples".
89

910
```R
10-
#To install a package from source:
11-
install.packages(path_to_targz_file, repos = NULL, type="source")
11+
library(devtools)
12+
install_github("shenorrLab/tuMap")
1213
#source the funcTutorial.R script:
1314
source(file.path(path_to_funcTutorial, 'funcTutorial.R'))
1415
#define the data directory path:

0 commit comments

Comments
 (0)