Browse Source

Update the README directory

Jose R Ortiz Ubarri 1 year ago
parent
commit
0f563dfcd6
1 changed files with 10 additions and 11 deletions
  1. 10
    11
      README.md

+ 10
- 11
README.md View File

@@ -1,17 +1,16 @@
1
-# Initial Maldisoft cmdline usage tutorial
1
+# Maldisoft cmdline usage tutorial
2 2
 
3
-If you are reading this is because you already unpacked the program.
4 3
 
5
-If you list the files and directories you will find the directories:
4
+Create the data and html directories:
6 5
 
7 6
 ```
8
-data
9
-html
7
+mkdir data
8
+mkdir html
10 9
 ```
11 10
 
12
-In the data directory you **MUST** create a sub directory with the data that you want to analyze together and then create a directory inside html where the results will be written.
11
+Inside the `data` directory you **MUST** create a sub directory for the data that you want to analyze together. Then, inside the `html` directory you MUST also create a subdirectory where the results will be written.
13 12
 
14
-For instance for the NIH example:
13
+For example if you plan to analize data from the database nih:
15 14
 ```
16 15
 mkdir data/nih
17 16
 mkdir html/nih
@@ -19,7 +18,7 @@ mkdir html/nih
19 18
 
20 19
 Copy inside `data/nih` the data to be analyzed.
21 20
 
22
-The list of peaks that you want to analyze is inside the file peaks.txt.  If you want to remove or add a new peak just follow the same format that is inside the file.  
21
+The list of peaks that you want to analyze is inside the file peaks.txt.  If you want to remove or add a new peak just follow the same one column format that is inside the file.  
23 22
 
24 23
 Currently:
25 24
 
@@ -35,19 +34,19 @@ Currently:
35 34
 To run the program you just need to follow the following syntax in the terminal:
36 35
 
37 36
 ```
38
-python maldisoft.py peaks.txt html/sample_name/ data/sample_name/*
37
+python2 maldisoft.py peaks.txt html/sample_name/ data/sample_name/*
39 38
 ```
40 39
 
41 40
 For the NIH example it would be:
42 41
 ```
43
-python maldisoft.py peaks.txt html/nih/ data/nih/*
42
+python2 maldisoft.py peaks.txt html/nih/ data/nih/*
44 43
 ```
45 44
 
46 45
 The results should be inside `html/nih`.
47 46
 
48 47
 To open the results page in your computer go to the directory and double click the index.html file.
49 48
 
50
-If you have a mac just do:
49
+If you have an apple machine just do:
51 50
 
52 51
 ```
53 52
 open html/nih/index.html