Skip to content

Commit 7ce2fd4

Browse files
committed
Merge remote-tracking branch 'origin/main' into dev
2 parents 5cd1bfe + 591ba4c commit 7ce2fd4

2 files changed

Lines changed: 485 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ any installation steps given the system supports running either docker container
5353
installed.
5454

5555
```bash
56-
nextflow run dessimozlab/FastOMA -profile docker --input_folder /path/to/in_folder --output_folder /path/to/out_folder
56+
nextflow run dessimozlab/FastOMA -profile docker --input_folder /path/to/in_folder --output_folder /path/to/out_folder
5757
```
58-
58+
You could also add specific version to be used by adding `-r v0.3.1` to the command line.
5959
Nextflow will automatically fetch the [dessimozlab/FastOMA](https://github.com/dessimozlab/FastOMA) repository and starts
6060
the `FastOMA.nf` workflow. The `-profile` argument must be used to specify the profile to use. We support `docker`,
6161
`singularity` and `conda` which then automatically set up the necessary tools by downloading the required containers or creating
@@ -91,7 +91,7 @@ The FastOMA workflow can be run directly without any installation using nextflow
9191
nextflow run desimozlab/FastOMA -r v0.3.1 -profile conda
9292
```
9393

94-
This will fetch version 0.3.1 from github and run the FastOMA workflow using the conda profile. See section [How to run fastOMA](#how-to-run-fastoma).
94+
This will fetch version v0.3.1 from github and run the FastOMA workflow using the conda profile. See section [How to run fastOMA](#how-to-run-fastoma).
9595

9696
### 2. Cloning the FastOMA repo and running from there
9797

@@ -140,7 +140,7 @@ bashMiniconda3.sh
140140
Then follow the instruction on the terminal. Finally, close and re-open the terminal and run
141141
```
142142
conda create -n fastoma python=3.9 --file environment-conda.yml
143-
cond activate mamba activate FastOMA
143+
conda activate fastoma
144144
```
145145
Then, clone and install fastOMA using
146146
```
@@ -154,7 +154,7 @@ Alternatively, you could use Mamba instead of Conda (which needs its own [instal
154154
Note that it is not encouraged to have both Mamba and conda on one system, [more info](https://stackoverflow.com/questions/76760906/installing-mamba-on-a-machine-with-conda).
155155

156156
```
157-
mamba env create -n FastOMA -f environment_conda.yml
157+
mamba env create -n FastOMA -f environment-conda.yml
158158
mamba activate FastOMA
159159
```
160160

@@ -184,7 +184,7 @@ nextflow run FastOMA.nf -profile docker \
184184
--output_folder myresult/
185185
```
186186
This will use the container that is tagged with the current commit id. Similarly, one could also use
187-
`--container_version "0.3.1"` to use the container with version `dessimozlab/fastoma:0.3.1` from dockerhub.
187+
`--container_version "0.3.1"` to use the container with version `dessimozlab/fastoma:0.3.1` from dockerhub. Check the latest version on the [DockerHub](https://hub.docker.com/r/dessimozlab/fastoma/tags).
188188

189189
### Singularity
190190
Since Docker needs administrator privileges (root access), [Singluarity](https://apptainer.org/index.html) (a.k.a Apptainer) is a good alternative. This can be installed using [Conda](https://anaconda.org/conda-forge/singularity) with `conda install conda-forge::singularity`. However, in most of the academic HPC cluster, singluarity is already installed and can be called with `module load`.
@@ -449,6 +449,7 @@ Majidian, Sina, Yannis Nevers, Ali Yazdizadeh Kharrazi, Alex Warwick Vesztrocy,
449449

450450

451451
## Change log
452+
- Update v0.3.1: spliting HOG and sampling
452453
- Update v0.1.6: adding dynamic resources, additional and improved output
453454
- Update v0.1.5: docker, add help, clean nextflow
454455
- Update v0.1.4: new gene families with linclust if mmseqs is installed, using quoted protein name to handle species chars, check input first

0 commit comments

Comments
 (0)