lefse

Production rapide des PNG pour une analyse LEFSE

Table des matières cliquable

  1. Analyse LEFSE

  2. Automatisation en Perl

  3. Installation

  4. Aide en ligne et path en option

1. Analyse LEFSE
La production des images PNG avec LEFSE est assez facile à exécuter, puisqu'il n'y a qu'à enchainer les commandes. Toutefois c'est un peu rébarbatif ! Nous proposons ici un fichier Perl nommé lefse.pl qui ne demande que le nom des données (et éventuellement le chemin d'accès aux scripts Python) et qui produit en retour les deux images voulues. Voici un exemple :
     > ls # un seul fichier avant
     
       data.txt
     
     > perl lefse.pl data.txt ~/Scripts/Python2
     
       Lefse Analysis (gH) version 1.03
     
       1. format input...   done
       2. lefse results...  done
       3. plot results...   done
       4. plot cladogram... done
     
      Computed files:   data.in  and data.res
      Available images: data.png and data_clad.png
     
     
     > ls # 4 nouveaux fichiers dont les 2 images PNG
     
       data.txt
       data.in
       data.res
       data.png
       data_clad.png
     
Il faut bien sûr que tout soit configuré et installé, avec python 2.7 (modules rpy2, numpy, matplotlib, argparse) et R 3.3 (packages survival, mvtnorm, modeltools, coin, MASS), de même que les scripts LEFSE (format_input.py, run_lefse.py, plot_res.py, plot_cladogram.py...).
2. Automatisation en Perl
Le script tient en quelques dizaines de lignes puisqu'en gros, il ne s'agit que d'exécuter 4 commandes, une fois les noms de fichiers choisis :
     python format_input.py    DATA     INFILE -u 1 -c 2 -o 1000000
     
     python run_lefse.py       INFILE   RESFILE
     
     python plot_res.py        RESFILE  PNGFILE
     
     python plot_cladogram.py  RESFILE  CLADFILE
     
Voici le code Perl, téléchargeable via le fichier lefse.pl :

# # (gH) -_- lefse.pl ; TimeStamp (unix) : 09 Novembre 2016 vers 15:14 ################################################################################# # # this script automates the production of png with lefse # ################################################################################# print "\n Lefse Analysis (gH) version 1.05\n\n" ; use strict ; use warnings ; use POSIX qw/ceil/; # check if the parameter baseName is present if ($#ARGV==-1) { print " MANDATORY PARAMETER MISSING." ; print " Syntax: perl lefse.pl INPUT_FILE [PATH for *py files]\n\n" ; print " Examples: perl lefse.pl hmp.txt\n" ; print " perl lefse.pl hmp.txt ~/Scripts/\n\n" ; print " Help: perl lefse.pl -h or perl lefse.pl --help\n\n" ; exit(-1) ; } ; # end if # detailed help if (($ARGV[0] eq "-h") or ($ARGV[0] eq "--help")) { print " The script lefse.pl automates the production of png for LEfSE analysis.\n" ; print " Just give the name of the file to be processed and the path to the Python scripts for Lefse analysis.\n\n" ; print " If these scripts files are already in the same directory, just give the name of the file to be processed.\n\n" ; exit(-2) ; } ; # end if # check if the input file is present my $dataFile = $ARGV[0] ; if (!-e $dataFile) { print " file $dataFile not found.STOP.\n\n" ; exit(-3) ; } ; # end if # get the baseName and build the output names my $idx = rindex($dataFile,".") ; my $baseName = "" ; if ($idx==-1) { $baseName = $dataFile ; } else { $baseName = substr($dataFile,0,$idx) ; } ; # fin si my $inFile = $baseName.".in" ; my $resFile = $baseName.".res" ; my $pngFile = $baseName.".png" ; my $cladFile = $baseName."_clad.png" ; # remove silently old output files system("rm -f $inFile $resFile $pngFile $cladFile") ; # define $path if parameter PATH is defined my $path = "" ; if ($ARGV[1]) { $path = $ARGV[1] ; if (substr($path,length($path)-1,1) ne "/") { $path .= "/" ; } ; # fin si } ; # fin si # check if python files are OK my @progFiles= ( "format_input.py", "run_lefse.py", "plot_res.py", "plot_cladogram.py" ) ; my $err = 0 ; foreach my $filename (sort @progFiles) { my $fn = $path.$filename ; if (!-e $fn) { print " required file $filename not found.\n" ; $err++ ; } ; # fin si } ; # fin pour chaque if ($err>0) { print "\n" ; print" STOP.\n\n" ; exit(-4) ; } ; # fin si # step 1. format input print(" 1. format input...") ; my $cmd1 = " python ".$path."format_input.py $dataFile $inFile -u 1 -c 2 -o 1000000 " ; system("$cmd1 > log1.txt") ; print " done\n" ; if (!-e $inFile) { print " Something went wrong. Please consult log1.txt" ; exit(-5) ; } ; # fin si # step 2. lefse results print(" 2. lefse results...") ; my $cmd2 = " python ".$path."run_lefse.py $inFile $resFile" ; system("$cmd2 > log2.txt") ; print " done\n" ; if (!-e $resFile) { print " Something went wrong. Please consult log2.txt" ; exit(-6) ; } ; # fin si # step 3. plot results print(" 3. plot results...") ; my $cmd3 = " python ".$path."plot_res.py $resFile $pngFile "; system("$cmd3 > log3.txt") ; print " done\n" ; if (!-e $pngFile) { print " Something went wrong. Please consult log3.txt" ; exit(-7) ; } ; # fin si # step 4. plot cladogram print(" 4. plot cladogram...") ; my $cmd4 = " python ".$path."plot_cladogram.py --format png $resFile $cladFile " ; system("$cmd4 > log4.txt") ; print " done\n" ; if (!-e $cladFile) { print " Something went wrong. Please consult log4.txt" ; exit(-8) ; } ; # fin si # at last, tell which produced files are available print "\n" ; print " Computed files: $inFile and $resFile \n"; print " Available images: $pngFile and $cladFile \n"; print "\n" ;

Les seuls paramètres choisis pour l'exécution du formatage sont -u 1, -c 2 et -o 1000000. Cela signifie que les individus sont définis au niveau de la ligne 1 et que les classes (ou regroupements) des colonnes sont définies au niveau de la ligne 2 (pas de sous-classes ou de sous-groupes possibles ici). Voici un mini-exemple de données telles qu'elles doivent être formatées :
     subject_id            158721788   158721788   159146620      # ligne 1 : individus
     oxygen_availability   High        Mid         Mid            # ligne 2 : classes
     Archaea               2.96541e-06 5.08937e-06 4.93921e-06    # ensuite les abondances
     Bacteria              0.999994    0.99999     0.99999        # ...
     
L'analyse prendra donc les sujets en ligne 1 et en fera l'analyse par disponibiité en oxygène (ligne 2).

Si vos données ne sont pas stucturées ainsi, vous pouvez utiliser notre script preLefse.php prévu pour cela.
3. Installation
Il n'y aucune installation à faire, il faut juste récupérer le script lefse.pl par exemple sous Linux avec la commande :
     wget http://forge.info.univ-angers.fr/~gh/Metaseed/lefse.pl
     
Pour tester si tout cela fonctionne, vous pouvez exécuter ou copier/coller les commandes suivantes :
     mkdir testLefse
     cd    testLefse
     wget  http://forge.info.univ-angers.fr/~gh/Metaseed/testLefse.zip
     unzip testLefse.zip
     perl  lefse.pl exemple.txt
     
Si tout s'est bien passé, vous devriez disposer au bout d'une dizaine de secondes des deux images suivantes :
4. Aide en ligne et path en option
L'aide en ligne est minimale puisqu'il faut juste donner le nom du fichier à traiter. Par contre, si les fichiers Python pour Lefse ne sont pas dans le répertoire courant, il faut préciser le chemin d'accès. C'est ce que dit l'aide, accessible par le paramètre -h ou --help :
     # sans paramètre, le programme "se plaint" :
     
     > perl lefse.pl
     
      Lefse Analysis (gH) version 1.03
     
      MANDATORY PARAMETER MISSING. Syntax: perl lefse.pl INPUT_FILE [PATH for *py files]
     
      Examples: perl lefse.pl hmp.txt
                perl lefse.pl hmp.txt ~/Scripts/
     
      Help: perl lefse.pl -h or perl lefse.pl --help
     
     # si on demande l'aide, on l'a !
     
     > perl lefse.pl -h
     
       Lefse Analysis (gH) version 1.03
     
      The script lefse.pl automates the production of png for LEFSE analysis.
      Just give the name of the file to be processed and the path to the Python scripts for Lefse analysis.
     
      If these scripts files are already in the same directory, just give the name of the file to be processed.
     
     # de toutes façons, si les fichiers ne sont pas présents, cela se passera mal !
     
     > perl lefse.pl essai.txt
     
      Lefse Analysis (gH) version 1.03
     
      required file format_input.py not found.
      required file plot_cladogram.py not found.
      required file plot_res.py not found.
      required file run_lefse.py not found.
     
      STOP.
     
     # avec le PATH sur les fichiers Python, tout va bien :
     
     > perl lefse.pl essai.txt ~/Scripts/Python2
     
       Lefse Analysis (gH) version 1.03
     
       1. format input...   done
       2. lefse results...  done
       3. plot results...   done
       4. plot cladogram... done
     
      Computed files:   essai.in  and essai.res
      Available images: essai.png and essai_clad.png
     
     
     > ls # 5 fichiers (4 nouveaux) dont les 2 images PNG
     
       essai.txt
       essai.in
       essai.res
       essai.png
       essai_clad.png
     
Retour à la page principale de (gH)