Skip to content

Commit 427d088

Browse files
committed
update
1 parent 5d92ae7 commit 427d088

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

File renamed without changes.

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ and 3) run FastOMA using the nextflow recipe `FastOMA_light.nf`.
4040
```
4141
nextflow FastOMA_light.nf --input_folder /path/to/in_folder --output_folder /path/to/out_folder
4242
```
43-
43+
The script `FastOMA_light.nf` is tailored for a few species. To run FastOMA with hundreds of species, please use `FastOMA.nf`.
4444

4545
# How to install FastOMA
4646

@@ -109,7 +109,7 @@ mv Primates.h5 in_folder/omamerdb.h5
109109
```
110110
(This is for the test however, I would suggest downloading the `LUCA.h5` instead of `Primates.h5` for your real analysis.). Check the item 2 in the [input section](https://github.com/sinamajidian/FastOMA#input) for details.
111111

112-
Now we have such a structre in our testdata folder.
112+
Now we have such a structure in our testdata folder.
113113
```
114114
$ tree ../testdata/in_folder
115115
├── omamerdb.h5
@@ -125,6 +125,9 @@ Finally, run the package using nextflow as below:
125125
# cd FastOMA/testdata
126126
nextflow ../FastOMA_light.nf --input_folder in_folder --output_folder out_folder -with-report
127127
```
128+
The script `FastOMA_light.nf` is tailored for a few species. In real case scenario, please use `FastOMA.nf`.
129+
130+
128131
Note that to have a comprehensive test, we set the default value of needed cpus as 10.
129132
## expected log for test data
130133
After few minutes, the run for test data finishes.
@@ -141,7 +144,7 @@ If the run interrupted, by adding `-resume` to the nextflow commond line, you ca
141144
Then, following files and folders should appear in the folder `out_folder` which was the argument.
142145
```
143146
$ls out_folder
144-
hogmap OrthologousGroupsFasta OrthologousGroups.tsv output_hog.orthoxml
147+
hogmap OrthologousGroupsFasta OrthologousGroups.tsv rootHOGs.tsv output_hog.orthoxml
145148
```
146149
among which `output_hog.orthoxml` is the final output in [orthoXML format](https://orthoxml.org/0.4/orthoxml_doc_v0.4.html). Its content looks like this
147150

@@ -199,9 +202,9 @@ For running on a SLURM cluster you can add `-c ../nextflow_slurm.config` to the
199202
```
200203
# cd FastOMA/testdata
201204
# rm -r out_folder work # You may remove stuff from previous run
202-
# ls ../FastOMA_light.nf
205+
# ls ../FastOMA.nf
203206
204-
nextflow ../FastOMA_light.nf -c ../nextflow_slurm.config --input_folder in_folder --output_folder out_folder
207+
nextflow ../FastOMA.nf -c ../nextflow_slurm.config --input_folder in_folder --output_folder out_folder
205208
```
206209

207210
You may need to re-run nextflow command line by adding `-resume`, if the allocated time is not enough for your dataset.

0 commit comments

Comments
 (0)