BUSCO/fr: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
(Created page with "{{Warning |title=Cette section est obsolète. |content=Nous travaillons sur sa mise à jour. }}")
No edit summary
 
(20 intermediate revisions by 2 users not shown)
Line 17: Line 17:
<b>1.</b> Chargez les modules requis.
<b>1.</b> Chargez les modules requis.
{{Commands
{{Commands
|module load StdEnv/2020 gcc python/3.10 augustus hmmer blast+ metaeuk prodigal r bbmap}}
|module load StdEnv/2020 gcc/9.3.0 python/3.10 augustus/3.5.0 hmmer/3.3.2 blast+/2.13.0 metaeuk/6 prodigal/2.6.3 r/4.3.1 bbmap/38.86}}


<b>2.</b> Créez l'environnement virtuel.
<b>2.</b> Créez l'environnement virtuel.
Line 28: Line 28:
{{Command
{{Command
|prompt=(busco_env) $
|prompt=(busco_env) $
|pip install biopython pandas busco --no-index
|pip install --no-index biopython{{=}}{{=}}1.81 pandas{{=}}{{=}}2.1.0 busco{{=}}{{=}}5.5.0
}}
}}


Line 57: Line 57:
===== <b>6.1</b>  Téléchargement avec la commande <code>busco</code> =====
===== <b>6.1</b>  Téléchargement avec la commande <code>busco</code> =====
Cette option est recommandée. Entrez la commande suivante dans votre répertoire de travail pour télécharger l’ensemble de données, par exemple
Cette option est recommandée. Entrez la commande suivante dans votre répertoire de travail pour télécharger l’ensemble de données, par exemple
{{Commands
{{Command
|busco --download bacteria_odb10
|busco --download bacteria_odb10
}}
}}
Line 69: Line 69:
::1. créer une hiérarchie pour les ensembles de données,
::1. créer une hiérarchie pour les ensembles de données,
::2. télécharger les ensembles de données appropriés,
::2. télécharger les ensembles de données appropriés,
::3. décompresser le ou les fichiers,,
::3. décompresser le ou les fichiers,
::4. si plusieurs fichiers sont téléchargés, ils seront automatiquement ajoutés au répertoire des lignées.  
::4. si plusieurs fichiers sont téléchargés, ils seront automatiquement ajoutés au répertoire des lignées.  


La hiérarchie sera esmblable à
La hiérarchie sera semblable à
<blockquote>
<blockquote>
* busco_downloads/
* busco_downloads/
Line 128: Line 128:
Utilisez <code>--in genome.fna</code> pour analyser un seul fichier.  
Utilisez <code>--in genome.fna</code> pour analyser un seul fichier.  


Utilisez <code>--in genome/</code> pour analyser un seul fichier
Utilisez <code>--in genome/</code> pour analyser plusieurs fichiers.


===== Conseils pour Slurm  =====
===== Conseils pour Slurm  =====
Line 156: Line 156:


# Load modules dependencies.
# Load modules dependencies.
module load StdEnv/2020 gcc python augustus hmmer blast+ metaeuk prodigal r bbmap
module load StdEnv/2020 gcc/9.3.0 python/3.10 augustus/3.5.0 hmmer/3.3.2 blast+/2.13.0 metaeuk/6 prodigal/2.6.3 r/4.3.1 bbmap/38.86


# Generate your virtual environment in $SLURM_TMPDIR.
# Generate your virtual environment in $SLURM_TMPDIR.
Line 171: Line 171:
}}
}}


====Augustus parameters====
====Paramètres Augustus ====
<b>9.</b> Advanced users may want to use Augustus parameters: <code>--augustus_parameters="--yourAugustusParameter"</code>.
<b>9.</b> Si vous avez plus d'expérience, vous pouvez utiliser les paramètres Argutus : <code>--augustus_parameters="--yourAugustusParameter"</code>.


*Copy the Augustus <i>config</i> directory to a writable location.
*Copiez le répertoire <i>config</i> d'Augustus à un endroit où la lecture est possible.
{{Command|cp -r $EBROOTAUGUSTUS/config $HOME/augustus_config}}
{{Command|cp -r $EBROOTAUGUSTUS/config $HOME/augustus_config}}


*Make sure to define the <code>AUGUSTUS_CONFIG_PATH</code> environment variable.
*Assurez-vous de définir la variable d'environnement  <code>AUGUSTUS_CONFIG_PATH</code>.
{{Command|export AUGUSTUS_CONFIG_PATH{{=}}$HOME/augustus_config}}
{{Command|export AUGUSTUS_CONFIG_PATH{{=}}$HOME/augustus_config}}


====SEPP parameters====
====Paramètres SEPP ====
<b>10.</b> To use SEPP parameters, you need to install SEPP locally in your virtual environment. This should be done in a login node.
<b>10.</b> Pour utiliser ces paramètres, SEPP doit être installé localement dans votre environnement virtuel, ce que vous devez faire à partir du nœud de connexion.


<b>10.1.</b> Activate your BUSCO virtual environment.
<b>10.1.</b> Activez votre environnement virtuel BUSCO.
{{Commands
{{Commands
|source busco_env/bin/activate
|source busco_env/bin/activate
}}
}}


<b>10.2.</b> Install DendroPy.
<b>10.2.</b> Installez DendroPy.
{{Commands
{{Commands
|pip install 'dendropy<4.6'
|pip install 'dendropy<4.6'
}}
}}


<b>10.3.</b> Install SEPP.
<b>10.3.</b> Installez SEPP.
{{Commands
{{Commands
|git clone https://github.com/smirarab/sepp.git
|git clone https://github.com/smirarab/sepp.git
Line 201: Line 201:
}}
}}


<b>10.4.</b> Validate the installation.
<b>10.4.</b> Validez l'installation.
{{Commands
{{Commands
|cd
|cd
Line 207: Line 207:
}}
}}


<b>10.5.</b> Because SEPP is installed locally, you cannot create the virtual environment as described in the previous submission script. To activate your local virtual environment, simply add the following command immediately under the line to load the module:
<b>10.5.</b> Puisque SEPP est installé localement, vous ne pouvez pas utiliser le script ci-dessus pour créer votre environnement virtuel. Pour activer votre environnement virtuel, ajoutez la commande suivante sur la ligne qui suit la commande de chargement du module.
{{Commands
{{Commands
|source ~/busco_env/bin/activate
|source ~/busco_env/bin/activate
Line 216: Line 216:
{{Warning
{{Warning
|title=Cette section est obsolète.
|title=Cette section est obsolète.
|content=Nous travaillons sur sa mise à jour.
|content=Veuillez utiliser les wheels qui sont disponibles.
}}
}}


<div class="mw-translate-fuzzy">
<b>1.</b> Chargez les modules nécessaires.
<b>1.</b> Chargez les modules nécessaires.
{{Command|module load StdEnv/2018.3 gcc/7.3.0 openmpi/3.1.4 busco/3.0.2 r/4.0.2}}
{{Command|module load StdEnv/2018.3 gcc/7.3.0 openmpi/3.1.4 busco/3.0.2 r/4.0.2}}
Ceci charge aussi les modules pour <code>augustus, blast+, hmmer</code> et d'autres paquets requis par BUSCO.
Ceci charge aussi les modules pour Augustus, BLAST+, HMMER et d'autres paquets requis par BUSCO.
</div>


<div class="mw-translate-fuzzy">
<b>2.</b> Copiez le fichier de configuration
La commande <code>run_BUSCO.py</code> devrait prendre moins de 60 secondes. Les tâches dont la production est plus longue doivent être  [[Running jobs/fr|soumises à l'ordonnanceur]].
{{Command|cp -v $EBROOTBUSCO/config/config.ini.default $HOME/busco_config.ini}}
</div>
ou
{{Command|wget -O $HOME/busco_config.ini https://gitlab.com/ezlab/busco/raw/master/config/config.ini.default}}


<div class="mw-translate-fuzzy">
<b>3.</b> Modifiez le fichier de configuration. Les endroits où se trouvent les outils externes sont définis dans la dernière section.
Pour plus d’information, consultez le [https://busco.ezlab.org/busco_userguide.html manuel d'utilisation].
</div>
{{File
{{File
   |name=partial_busco_config.ini
   |name=partial_busco_config.ini
Line 269: Line 266:
}}
}}


<div class="mw-translate-fuzzy">
<b>4.</b>  Copiez le répertoire <code>config</code> d’Augustus à un endroit où la lecture est possible.
Pour connaître la plus récente version, lancez
{{Command|cp -r $EBROOTAUGUSTUS/config $HOME/augustus_config}}
{{Command|avail_wheel busco}}
 
== Wheels Python ==
<b>5.</b> Vérifiez si tout fonctionne bien.
=== Installation ===
<b>1.</b> Chargez les modules nécessaires.
{{Commands
|module load StdEnv/2020 gcc python/3.10
|module load python augustus hmmer blast+ metaeuk prodigal r}}
</div>


<div class="mw-translate-fuzzy">
<b>2.</b> Créez l'environnement virtuel.
{{Commands
{{Commands
|virtualenv busco_env
|export BUSCO_CONFIG_FILE{{=}}$HOME/busco_config.ini
|source busco_env/bin/activate
|export AUGUSTUS_CONFIG_PATH{{=}}$HOME/augustus_config
}}
|run_BUSCO.py --in $EBROOTBUSCO/sample_data/target.fa --out TEST --lineage_path $EBROOTBUSCO/sample_data/example --mode genome
</div>
 
<div class="mw-translate-fuzzy">
<b>3.</b> Installez le wheel et ses dépendances.
{{Command
|prompt=(busco_env) $
|pip install biopython pandas busco --no-index
}}
}}
</div>


La commande <code>run_BUSCO.py</code> devrait être exécutée sous les 60 secondes. Les tâches de production qui nécessitent plus de temps doivent être [[Running jobs/fr|soumises à l'ordonnanceur]].
La commande <code>run_BUSCO.py</code> devrait être exécutée sous les 60 secondes. Les tâches de production qui nécessitent plus de temps doivent être [[Running jobs/fr|soumises à l'ordonnanceur]].

Latest revision as of 15:37, 5 May 2024

Other languages:


BUSCO (pour Benchmarking Universal Single-Copy Orthologs) est une application qui permet d'évaluer la complétude de l'assemblage et de l'annotation de génomes.

Pour plus d'information, consultez le manuel de l'utilisateur.

Versions disponibles

Les versions récentes sont disponibles dans des wheels et les plus anciennes versions sont dans un module (voir la section Modules ci-dessous).

Pour connaître la dernière version disponible, lancez

Question.png
[name@server ~]$ avail_wheel busco

Wheel Python

Installation

1. Chargez les modules requis.

[name@server ~]$ module load StdEnv/2020 gcc/9.3.0 python/3.10 augustus/3.5.0 hmmer/3.3.2 blast+/2.13.0 metaeuk/6 prodigal/2.6.3 r/4.3.1 bbmap/38.86


2. Créez l'environnement virtuel.

[name@server ~]$ virtualenv ~/busco_env
[name@server ~]$ source ~/busco_env/bin/activate


3. Installez le wheel et ses dépendances.

Question.png
(busco_env) $ pip install --no-index biopython==1.81 pandas==2.1.0 busco==5.5.0

4. Validez l'installation.

Question.png
(busco_env) $ busco --help

5. Gelez l’environnement et le fichier requirements.txt pour utiliser ce fichier, voir le script bash montré au point 8.

Question.png
(busco_env) $ pip freeze > ~/busco-requirements.txt

Utilisation

Ensembles de données

6. Avant de soumettre une tâche, les ensembles de données doivent être téléchargés de BUSCO data.

Pour connaître les ensembles de données disponibles, entrez busco --list-datasets dans votre terminal.

Vous pouvez utiliser l'une des deux commandes suivantes :

  • busco
  • wget
6.1 Téléchargement avec la commande busco

Cette option est recommandée. Entrez la commande suivante dans votre répertoire de travail pour télécharger l’ensemble de données, par exemple

Question.png
[name@server ~]$ busco --download bacteria_odb10

Il est aussi possible de télécharger plusieurs ensembles de données en une opération en ajoutant les arguments all, prokaryota, eukaryota ou virus, par exemple

[name@server ~]$ busco --download virus

Ceci permet de

1. créer une hiérarchie pour les ensembles de données,
2. télécharger les ensembles de données appropriés,
3. décompresser le ou les fichiers,
4. si plusieurs fichiers sont téléchargés, ils seront automatiquement ajoutés au répertoire des lignées.

La hiérarchie sera semblable à

  • busco_downloads/
  • information/
lineages_list.2021-12-14.txt
  • lineages/
bacteria_odb10
actinobacteria_class_odb10
actinobacteria_phylum_odb10
  • placement_files/
list_of_reference_markers.archaea_odb10.2019-12-16.txt

Tous les fichiers de lignées se trouveront alors dans busco_downloads/lineages/. La présence de --download_path busco_downloads/ dans la ligne de commande BUSCO indiquera où trouver l’argument --lineage_dataset bacteria_odb10 pour l'ensemble de données. Si busco_download n’est pas votre répertoire de travail, il faudra fournir le chemin complet.

6.2 Téléchargement avec la commande wget

Tous les fichiers doivent être décompressés avec tar -xvf file.tar.gz.

[name@server ~]$ mkdir -p busco_downloads/lineages
[name@server ~]$ cd busco_downloads/lineages
[name@server ~]$ wget https://busco-data.ezlab.org/v5/data/lineages/bacteria_odb10.2020-03-06.tar.gz
[name@server ~]$ tar -xvf bacteria_odb10.2020-03-06.tar.gz


Test

7. Téléchargement des fichiers de génome.

[name@server ~]$ wget https://gitlab.com/ezlab/busco/-/raw/master/test_data/bacteria/genome.fna


8. Exécution.

Pour un seul génome :

Question.png
[name@server ~]$ busco --offline --in genome.fna --out TEST --lineage_dataset bacteria_odb10 --mode genome --cpu ${SLURM_CPUS_PER_TASK:-1} --download_path busco_download/

Pour plusieurs génomes, le répertoire genome/ doit se trouver dans le répertoire courant, autrement il faut donner le chemin complet :

Question.png
[name@server ~]$ busco --offline --in genome/ --out TEST --lineage_dataset bacteria_odb10 --mode genome --cpu ${SLURM_CPUS_PER_TASK:-1} --download_path busco_download/

La commande pour un seul génome devrait être exécutée sous les 60 secondes. Les tâches de production qui nécessitent plus de temps doivent être soumises à l'ordonnanceur.

Conseils pour BUSCO

Utilisez --in genome.fna pour analyser un seul fichier.

Utilisez --in genome/ pour analyser plusieurs fichiers.

Conseils pour Slurm

Utilisez --offline pour éviter l'utilisation de l’internet.

Utilisez --cpu avec $SLURM_CPUS_PER_TASK dans le script de la tâche pour utiliser le nombre alloué de CPU.

Utilisez --restart pour reprendre une tâche interrompue.

Soumettre une tâche

Vous pouvez soumettre le script suivant avec sbatch run_busco.sh.


File : run_busco.sh

#!/bin/bash

#SBATCH --job-name=busco9_run
#SBATCH --account=def-someprof    # adjust this to match the accounting group you are using to submit jobs
#SBATCH --time=01:00:00           # adjust this to match the walltime of your job
#SBATCH --cpus-per-task=8         # adjust depending on the size of the genome(s)/protein(s)/transcriptome(s)
#SBATCH --mem=20G                 # adjust this according to the memory you need

# Load modules dependencies.
module load StdEnv/2020 gcc/9.3.0 python/3.10 augustus/3.5.0 hmmer/3.3.2 blast+/2.13.0 metaeuk/6 prodigal/2.6.3 r/4.3.1 bbmap/38.86

# Generate your virtual environment in $SLURM_TMPDIR.
virtualenv --no-download ${SLURM_TMPDIR}/env
source ${SLURM_TMPDIR}/env/bin/activate

# Install busco and its dependencies.
pip install --no-index --upgrade pip
pip install --no-index --requirement ~/busco-requirements.txt

# Edit with the proper arguments, run your commands.
busco --offline --in genome.fna --out TEST --lineage_dataset bacteria_odb10 --mode genome --cpu ${SLURM_CPUS_PER_TASK:-1} --download_path busco_download/


Paramètres Augustus

9. Si vous avez plus d'expérience, vous pouvez utiliser les paramètres Argutus : --augustus_parameters="--yourAugustusParameter".

  • Copiez le répertoire config d'Augustus à un endroit où la lecture est possible.
Question.png
[name@server ~]$ cp -r $EBROOTAUGUSTUS/config $HOME/augustus_config
  • Assurez-vous de définir la variable d'environnement AUGUSTUS_CONFIG_PATH.
Question.png
[name@server ~]$ export AUGUSTUS_CONFIG_PATH=$HOME/augustus_config

Paramètres SEPP

10. Pour utiliser ces paramètres, SEPP doit être installé localement dans votre environnement virtuel, ce que vous devez faire à partir du nœud de connexion.

10.1. Activez votre environnement virtuel BUSCO.

[name@server ~]$ source busco_env/bin/activate


10.2. Installez DendroPy.

[name@server ~]$ pip install 'dendropy<4.6'


10.3. Installez SEPP.

[name@server ~]$ git clone https://github.com/smirarab/sepp.git
[name@server ~]$ cd sepp
[name@server ~]$ python setup.py config
[name@server ~]$ python setup.py install


10.4. Validez l'installation.

[name@server ~]$ cd
[name@server ~]$ run_sepp.py -h


10.5. Puisque SEPP est installé localement, vous ne pouvez pas utiliser le script ci-dessus pour créer votre environnement virtuel. Pour activer votre environnement virtuel, ajoutez la commande suivante sur la ligne qui suit la commande de chargement du module.

[name@server ~]$ source ~/busco_env/bin/activate


Modules

Cette section est obsolète.

Veuillez utiliser les wheels qui sont disponibles.



1. Chargez les modules nécessaires.

Question.png
[name@server ~]$ module load StdEnv/2018.3 gcc/7.3.0 openmpi/3.1.4 busco/3.0.2 r/4.0.2

Ceci charge aussi les modules pour Augustus, BLAST+, HMMER et d'autres paquets requis par BUSCO.

2. Copiez le fichier de configuration

Question.png
[name@server ~]$ cp -v $EBROOTBUSCO/config/config.ini.default $HOME/busco_config.ini

ou

Question.png
[name@server ~]$ wget -O $HOME/busco_config.ini https://gitlab.com/ezlab/busco/raw/master/config/config.ini.default

3. Modifiez le fichier de configuration. Les endroits où se trouvent les outils externes sont définis dans la dernière section.

File : partial_busco_config.ini

[tblastn]
# path to tblastn
path = /cvmfs/soft.computecanada.ca/easybuild/software/2017/avx512/Compiler/gcc7.3/blast+/2.7.1/bin/

[makeblastdb]
# path to makeblastdb
path = /cvmfs/soft.computecanada.ca/easybuild/software/2017/avx512/Compiler/gcc7.3/blast+/2.7.1/bin/

[augustus]
# path to augustus
path = /cvmfs/soft.computecanada.ca/easybuild/software/2017/avx512/Compiler/gcc7.3/augustus/3.3/bin/

[etraining]
# path to augustus etraining
path = /cvmfs/soft.computecanada.ca/easybuild/software/2017/avx512/Compiler/gcc7.3/augustus/3.3/bin/

# path to augustus perl scripts, redeclare it for each new script
[gff2gbSmallDNA.pl]
path = /cvmfs/soft.computecanada.ca/easybuild/software/2017/avx512/Compiler/gcc7.3/augustus/3.3/scripts/
[new_species.pl]
path = /cvmfs/soft.computecanada.ca/easybuild/software/2017/avx512/Compiler/gcc7.3/augustus/3.3/scripts/
[optimize_augustus.pl]
path = /cvmfs/soft.computecanada.ca/easybuild/software/2017/avx512/Compiler/gcc7.3/augustus/3.3/scripts/

[hmmsearch]
# path to HMMsearch executable
path = /cvmfs/soft.computecanada.ca/easybuild/software/2017/avx512/Compiler/gcc7.3/hmmer/3.1b2/bin/

[Rscript]
# path to Rscript, if you wish to use the plot tool
path = /cvmfs/soft.computecanada.ca/easybuild/software/2017/avx512/Compiler/gcc7.3/r/4.0.2/bin/


4. Copiez le répertoire config d’Augustus à un endroit où la lecture est possible.

Question.png
[name@server ~]$ cp -r $EBROOTAUGUSTUS/config $HOME/augustus_config

5. Vérifiez si tout fonctionne bien.

[name@server ~]$ export BUSCO_CONFIG_FILE=$HOME/busco_config.ini
[name@server ~]$ export AUGUSTUS_CONFIG_PATH=$HOME/augustus_config
[name@server ~]$ run_BUSCO.py --in $EBROOTBUSCO/sample_data/target.fa --out TEST --lineage_path $EBROOTBUSCO/sample_data/example --mode genome


La commande run_BUSCO.py devrait être exécutée sous les 60 secondes. Les tâches de production qui nécessitent plus de temps doivent être soumises à l'ordonnanceur.

Dépannage

Erreur : Cannot write to Augustus config path

Assurez-vous d’avoir copié le répertoire config d’Augustus à un endroit où la lecture est possible et d’avoir exporté la variable AUGUSTUS_CONFIG_PATH.