batchuserguide
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
batchuserguide [2008/10/08 10:18] dupierris |
batchuserguide [2010/08/27 14:27] (current) 132.168.73.9 |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Présentation générale ===== | ===== Présentation générale ===== | ||
| - | + | {{ :irma_batch_help.png|}} | |
| - | L'interface d'IRMa Batch est consitituée de la liste des fichiers à traiter sur la partir gauche et du script à exécuter sur la partie droite. Les fichiers peuvent être soit des projets IRMa, soit des résultats d'identification Mascot. Tous les fichiers doivent néanmoins être du même type et le script exécuté doit correspondre à ce format. | + | L'interface d'IRMa Batch est constituée de la liste des fichiers à traiter sur la partir gauche et du script à exécuter sur la partie droite. Les fichiers peuvent être soit des projets IRMa, soit des résultats d'identification Mascot. Tous les fichiers doivent néanmoins être du même type et le script exécuté doit correspondre à ce format. |
| ==== Les données ==== | ==== Les données ==== | ||
| - | Pour ajouter des données, il suffit de faire glisser un ou plusieurs résultats d'identification ( fichier *.dat) ou projets IRMa (répertoire *.irma) dans la partie gauche de l'interface. On peut ajouter autant de données que désiré. Il est également possible de supprimer un ou plusieurs fichiers ou même d'effacer la liste en utilisant les boutons adéquats (au dessus de la liste) | + | Pour ajouter des données, il suffit de faire glisser un ou plusieurs résultats d'identification ( fichier *.dat ou *.rov) ou projets IRMa (répertoire *.irma) dans la partie gauche de l'interface. On peut ajouter autant de données que désiré. Il est également possible de supprimer un ou plusieurs fichiers ou même d'effacer la liste en utilisant les boutons adéquats (au dessus de la liste) |
| ==== Le script ==== | ==== Le script ==== | ||
| Line 13: | Line 13: | ||
| * de charger un script existant. Cliquer sur le bouton au-dessus de la zone de texte pour rechercher le script sur le disque | * de charger un script existant. Cliquer sur le bouton au-dessus de la zone de texte pour rechercher le script sur le disque | ||
| * de créer entièrement le script en saisissant les opérations dans la zone de texte | * de créer entièrement le script en saisissant les opérations dans la zone de texte | ||
| - | * de partir d'un script existant (en le chargeant d'abord) puis de le modifier directement dans la zone de texte. **__Attention__**, les modifications **ne sont pas sauvegardées** et il n'est pas possible de les enregistrer depuis l'inertface. Si vous voulez les conserver, vous devez soit modifier le script dans un éditeur de texte classique, soit copier coller le script depuis la zone de texte dans un éditeur. | + | * de partir d'un script existant (en le chargeant d'abord) puis de le modifier directement dans la zone de texte. **__Attention__**, les modifications **ne sont pas sauvegardées** et il n'est pas possible de les enregistrer depuis l'interface. Si vous voulez les conserver, vous devez soit modifier le script dans un éditeur de texte classique, soit copier coller le script depuis la zone de texte dans un éditeur. |
| Dans tous les cas, le format du script doit correspondre aux spécifications données ci-dessous. | Dans tous les cas, le format du script doit correspondre aux spécifications données ci-dessous. | ||
| Line 23: | Line 23: | ||
| ===== Spécification du script ===== | ===== Spécification du script ===== | ||
| - | Le script est au format XML. C'est à dire, en très simplifier, qu'il est constitué de bloc, successifs et/ou imbriqués, de description. Chaque bloc est délimité par une balise ouvrante et une balise fermante : | + | Les scripts utilisés dans IRMa batch sont les mêmes que ceux définis pour le mode automatique. La description des paramètres possibles est accessible dans un [[autouserguide#scripts|chapitre spécifique ]]de la partie mode automatique. |
| - | <code> | + | |
| - | <script> // Balise ouvrante du bloc script | + | |
| - | ... // Contenu du bloc | + | |
| - | </script> // Balise fermante du bloc script | + | |
| - | </code> | + | |
| - | + | ||
| - | Tous script doit être décrit dans un bloc ''script'', comme indiqué ci-dessus. Le ''script'' est constitué de plusieurs actions correspondantes aux opérations que l'on souhaite exécuter. L'ordre de définition de ces actions sera l'ordre d'exécution des opérations associées. | + | |
| - | + | ||
| - | **Une description sommaire est donnée ici. Toutes les actions décrites ici correspondant à des fonctionnalités d'IRMa, plus de détail est donné dans le guide utilisateur d'IRMa.** | + | |
| - | + | ||
| - | ==== Parse d'un résultat Mascot ==== | + | |
| - | + | ||
| - | Cette opération n'est possible que si les données en entrée sont des résultats d'identification Mascot et non des projets IRMa. Elle correspond au parse Mascot réaliser dans IRMa avec les paramètres saisies dans la boite de dialogue (Report Settings/Parser Properties) | + | |
| - | + | ||
| - | La bloc //parse// est défini comme illustré ci-dessous: une balise ''parse'', suivi d'une balise ''parameters'' qui encapsule tous les paramètres et autant de balise ''parameter'' que de paramètres à définir. Pour chaque paramètre, il est nécessaire de donner son nom et sa valeur | + | |
| - | + | ||
| - | **__Exemple de bloc parse :__** | + | |
| - | <code> | + | |
| - | <parse> | + | |
| - | <parameters> | + | |
| - | <parameter name="is.hit.count.auto"> | + | |
| - | <value class="boolean">true</value> | + | |
| - | </parameter> | + | |
| - | <parameter name="protein.cutoff"> | + | |
| - | <value class="double">0.05</value> | + | |
| - | </parameter> | + | |
| - | <parameter name="ions.score.cutoff"> | + | |
| - | <value class="int">0</value> | + | |
| - | </parameter> | + | |
| - | <parameter name="subset.threshold"> | + | |
| - | <value class="double">0.5</value> | + | |
| - | </parameter> | + | |
| - | <parameter name="read.sequence"> | + | |
| - | <value class="string">masters</value> | + | |
| - | </parameter> | + | |
| - | </parameters> | + | |
| - | </parse> | + | |
| - | </code> | + | |
| - | + | ||
| - | **__liste des paramètres possibles:__** | + | |
| - | * nom: ''is.hit.count.auto''; valeur autorisée ''false'' ou ''true'' ; spécifie comment l'on souhaite obtenir la liste des hits. En fixant le nombre absolue de hit (false) ou en spécifiant une p value (true) | + | |
| - | * nom: ''protein.cutoff''; valeur décimale ; spécifie la p value à utiliser pour obtenir la liste des hits. paramètre utile que si ''is.hit.count.auto'' = true | + | |
| - | * nom: ''hit.count''; valeur entière; spécifie le nombre de hits désirés. paramètre utile que si ''is.hit.count.auto'' = false | + | |
| - | * nom: ''ions.score.cutoff''; valeur entière ; spécifie le score minimale d'un peptide pour qu'il soit pris en compte | + | |
| - | * nom: ''subset.threshold''; valeur entière ; spécifie le score minimale d'un peptide pour qu'il soit pris en compte | + | |
| + | ===== Utilisation du moteur externe ===== | ||
| + | Si vous avez un très grand nombre (plusieurs centaine) d'identifications à traiter il convient d'utiliser une option qui rend IRMa batch plus stable (mais qui en retour génère énormément de fichier de log (1 par identification)). Pour cela il faut ouvrir le fichier runBatch.bat avec un éditeur de texte et rajouter le paramètre "-external" à la ligne de commande. | ||
| + | Exemple : | ||
| + | * Utilisation normal : java -Djava.library.path=./lib -Xms256m -Xmx512m -cp IRMa-1.26.2.jar cea.irma.batch.IRMaBatchApp | ||
| + | * Utilisation du moteur externe : java -Djava.library.path=./lib -Xms256m -Xmx512m -cp IRMa-1.26.2.jar cea.irma.batch.IRMaBatchApp **-external** | ||
batchuserguide.1223453886.txt.gz · Last modified: 2008/10/08 10:18 by dupierris
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
