bp_panalysis.plp – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

panalysis.PLS – Ein Beispiel-/Tutorial-Skript für den Zugriff auf Analysetools

ZUSAMMENFASSUNG

# Führen Sie eine Analyse mit Ihrer Sequenz in einer lokalen Datei durch
./panalysis.PLS -n 'edit.seqret'-w -r \
sequence_direct_data=@/home/testdata/my.seq

Weitere Beispiele finden Sie im Text unten.

BESCHREIBUNG

Ein Client, der zeigt, wie das Modul „Bio::Tools::Run::Analysis“ verwendet wird, ein Modul zum Ausführen und
Steuerung lokaler oder entfernter Analysetools. Es ruft auch Methoden aus dem auf
Modul „Bio::Tools::Run::AnalysisFactory“, ein Modul, das Listen der verfügbaren Analysen bereitstellt.

In erster Linie ist dieser Client als Beispiel für die Verwendung von Analysemodulen gedacht
Testen Sie sie. Allerdings, weil es viele Optionen bietet, um möglichst viele Methoden abzudecken
Nach Möglichkeit kann es auch als voll funktionsfähiger Befehlszeilen-Client für den Zugriff verwendet werden
verschiedene Analysetools.

Definieren Standorte und Zugang Methode
„panalysis.PLS“ ist unabhängig von der Zugriffsmethode auf die Remote-Analysen (die Analysen).
läuft auf einem anderen Rechner). Die zur Kommunikation mit den Analysen verwendete Methode ist
definiert durch die Option „-A“ mit dem Standardwert Seife. Die anderen möglichen Werte (nicht
noch unterstützt, aber bald erhältlich) sind Suppe und aus einer regionalen.

Jede Zugriffsmethode kann eine unterschiedliche Bedeutung für den Parameter „-l“ haben, der einen Speicherort definiert
Dienste, die den Zugriff auf die Analysetools ermöglichen. Zum Beispiel die Seife Der Zugriff erwartet eine URL
eines Webdienstes in der Option „-l“, während die Suppe Der Zugriff kann hier eine Zeichenfolge finden
Interoperable Objektreferenz (IOR).

Ein Standardspeicherort für Seife Zugriff ist „http://www.ebi.ac.uk/soaplab/services" welcher
vertritt Dienstleistungen, die am Europäischen Bioinformatik-Institut zusätzlich zu über hundert angeboten werden
EMBOSS-Analysen (und neben einigen anderen).

Verfügbar Analysen
„panalysis.PLS“ kann eine Liste der verfügbaren Analysen anzeigen (vom angegebenen Standort aus unter Verwendung von gegeben).
Zugriffsmethode). Die Option „-L“ zeigt alle Analysen an, die Option „-c“ listet alle verfügbaren auf
Kategorien (Eine Kategorie ist eine Gruppe von Analysen mit ähnlicher Funktionalität oder Verarbeitung
ähnlicher Datentyp), und schließlich zeigt die Option „-C“ nur die darin verfügbaren Analysen an
der angegebenen Kategorie.

Beachten Sie, dass alle diese Funktionen vom Modul „Bio::Tools::Run::AnalysisFactory“ bereitgestellt werden.
(bzw. durch eine seiner zugriffsabhängigen Unterklassen). Das Modul verfügt außerdem über eine Fabrik
Methode „create_analysis“, die von diesem Skript nicht verwendet wird.

Service
Ein „Dienst“ ist eine höhere Abstraktionsebene eines Analysetools. Es versteht einen gut
definierte Schnittstelle (Modul „Bio::AnalysisI“, eine Tatsache, die es diesem Skript ermöglicht, zu sein
unabhängig vom Zugriffsprotokoll auf verschiedene Dienste.

Der Dienstname muss durch die Option „-n“ angegeben werden. Diese Option kann nur weggelassen werden, wenn Sie
hat nur die „Factory“-Methoden aufgerufen (oben beschrieben).

Jeder Dienst (der ein Analysetool, ein Programm oder eine Anwendung darstellt) hat seine eigene
Beschreibung, verfügbar über die Optionen „-a“ (Analysename, Typ usw.), „-i“, „-I“
(Angabe der Analyseeingabedaten, am wichtigsten sind deren Namen) und „-o“, „-O“
(Ergebnisnamen und ihre Typen). Die Option „-d“ liefert die detaillierteste Beschreibung im
XML-Format.

Die Dienstbeschreibung ist nett, aber das Wichtigste ist, den Dienst zum Aufrufen zu verwenden
ein zugrunde liegendes Analysetool. Für jeden Aufruf erstellt der Dienst einen „Job“ und füttert ihn
mit Eingabedaten. Es gibt drei Phasen: (a) einen Job erstellen, (b) den Job ausführen und (c) warten
für dessen Vollendung. Entsprechend. Es gibt drei Optionen: das „-b“, das gerade erstellt
(erstellt) einen Job, das „-x“, das einen Job erstellt und ausführt, und schließlich „-w“, das
erstellt einen Job, führt ihn aus und blockiert den Client, bis der Job abgeschlossen ist. Immer nur eines davon
Diese Optionen werden verwendet (daher macht es keinen Sinn, mehr davon zu verwenden, die „panalysis.PLS“
priorisiert sie in der Reihenfolge „-x“, „-w“ und „-b“).

Alle diese Optionen übernehmen Eingabedaten von der Befehlszeile (siehe nächster Abschnitt dazu) und
Alle geben (intern) ein Objekt zurück, das einen Job darstellt. Es gibt viele Methoden
(Optionen) Umgang mit den Jobobjekten (siehe einen übernächsten Abschnitt darüber).

Letzter Hinweis in diesem Abschnitt: Die Option „-b“ ist eigentlich optional – es wird sogar ein Job erstellt
ohne diese Option, wenn in der Befehlszeile einige Eingabedaten gefunden werden. Du haben zu
Verwenden Sie es jedoch, wenn Sie keine Daten an ein Analysetool übergeben (ein Beispiel wäre das
berühmten „Classic::HelloWorld“-Dienst).

zufuhr technische Daten
Eingabedaten werden als Name/Wert-Paare angegeben und mit einem Gleichheitszeichen dazwischen in die Befehlszeile eingegeben
Name und Wert. Wenn die Wert Teil beginnt mit einem nicht maskierten Zeichen „@“, es wird als verwendet
lokalen Dateinamen und „panalysis.PLS“ liest die Datei und verwendet stattdessen deren Inhalt.
Beispiele:

panalysis.PLS -n edit.seqret -w -r
sequence_direct_data='tatatctcccc' osformat=embl

panalysis.PLS ...
sequence_direct_data=@/my/data/my.seq

Die Namen der Eingabedaten stammen aus der „Eingabespezifikation“, die durch das „-i“ angezeigt werden kann.
oder „-I“-Optionen. Die Eingabespezifikation (bei Verwendung der Option „-I“) wird bei einigen auch angezeigt
Eingaben – eine Liste zulässiger Werte. Die Spezifikation gibt jedoch nicht an, um welche Eingabe es sich handelt
Welche Daten sich gegenseitig ausschließen oder welche anderen Einschränkungen gelten. Wenn es einen Konflikt gibt, an
Die Fehlermeldung wird später erzeugt (bevor der Job startet).

Eingabedaten werden verwendet, wenn eine der Optionen „-b“, „-x“ oder „-w“ vorhanden ist, aber Option
„-j“ ist nicht vorhanden (siehe nächster Abschnitt zu dieser Joboption).

Job
Jeder Dienst (definiert durch einen in der Option „-n“ angegebenen Namen) kann einmal oder mehrmals ausgeführt werden
mal, mit den gleichen, aber meist mit unterschiedlichen Eingabedaten. Jede Ausführung erzeugt eine Job
Objekt. Tatsächlich wird der Job bereits vor der Ausführung erstellt (denken Sie daran, dass die Option „-b“
baut einen Job auf, führt ihn aber noch nicht aus).

Jeder Job, ob ausgeführt oder nicht, ist dauerhaft und kann später von einem anderen erneut verwendet werden
Aufruf des Skripts „panalysis.PLS“. Es sei denn, Sie zerstören den Job explizit mit
Option „-z“.

Auf einen Job, der durch die Optionen „-b“, „-x“ und „-w“ (und durch Eingabedaten) erstellt wurde, kann im zugegriffen werden
gleichen „panalysis.PLS“-Aufruf mit verschiedenen berufsbezogenen Optionen, die wichtigsten sind
„-r“ und „-R“ zum Abrufen von Ergebnissen aus dem abgeschlossenen Job.

Sie können jedoch auch einen Job neu erstellen, der durch einen vorherigen Aufruf erstellt wurde. Vorausgesetzt, dass Sie
Kennen Sie die Job-ID (die „panalysis.PLS“ druckt sie immer auf der Standardfehlerseite aus, wenn ein neuer Job erstellt wird).
erstellt wurde), verwenden Sie die Option „-j“, um den Job neu zu erstellen.

Beispiel:

./panalysis.PLS -n 'edit.seqret'
sequence_direct_data=@/home/testdata/my.seq

Es druckt:

JOB ID: edit.seqret/bb494b:ef55e47c99:-8000

Nächster Aufruf (Aufforderung, den Job auszuführen, auf seinen Abschluss zu warten und den Jobstatus anzuzeigen)
lassen sich:

./panalysis.PLS -n 'edit.seqret'
-j edit.seqret/bb494b:ef55e47c99:-800
-w -s

Und später kann ein weiterer Aufruf erneut nach Ergebnissen fragen:

./panalysis.PLS -n 'edit.seqret'
-j edit.seqret/bb494b:ef55e47c99:-800
-r

Hier ist eine Liste aller Joboptionen (mit Ausnahme der Ergebnisse, diese finden Sie im nächsten Abschnitt):

Auftragsausführung und -beendigung
Es gibt die gleichen Optionen „-x“ und „-w“ für die Ausführung eines Jobs und für dessen Ausführung und
warten auf ihre Fertigstellung, wie sie oben beschrieben wurden. Aber jetzt wirken die Optionen weiter
ein Job, der durch die Option „-j“ gegeben wird, jetzt verwenden sie keine Eingabedaten aus dem Befehl-
Zeile (die Eingabedaten mussten bei der Joberstellung verwendet werden).

Darüber hinaus gibt es die Option „-k“, um einen laufenden Job abzubrechen.

Berufsmerkmale
Andere Optionen geben Auskunft über den Jobstatus („-s“), über die Jobausführungszeiten („-t“ und
„-T“ und über das letzte verfügbare Ereignis, was mit dem Job passiert ist („-e“). Beachten Sie, dass
Die Ereignisbenachrichtigung ist noch nicht vollständig implementiert, daher wird sich diese Option im ändern
Zukunft, um mehr Benachrichtigungsmöglichkeiten zu bieten.

Die Ergebnisse
Das Wichtigste an den Analysetools sind natürlich ihre Ergebnisse. Die Ergebnisse sind
benannt (ähnlich wie die Eingabedaten) und können alle auf einmal mit abgerufen werden
Option „-r“ (damit Sie ihre Namen nicht wirklich kennen müssen) oder durch Angabe von (all or
einige) Ergebnisnamen mit der Option „-R“.

Wenn ein Ergebnis nicht existiert (entweder noch nicht oder der Name ist falsch), ist ein Undef-Wert vorhanden
zurückgegeben (keine Fehlermeldung erzeugt).

Manche Ergebnisse sollten besser direkt in Dateien gespeichert werden, anstatt sie im Terminal anzuzeigen
Fenster (dies gilt für die binär Ergebnisse, meist mit Bildern). Die „panalysis.PLS“
hilft beim Umgang mit binären Ergebnissen, indem es sie automatisch in lokalen Dateien speichert (eigentlich ist es
ist das Modul „Bio::Tools::Run::Analysis“ und seine Untermodule, die bei der Binärdatei helfen
Daten).

Warum also nicht eine herkömmliche Shell-Umleitung auf eine Datei verwenden? Es gibt zwei Gründe.
Erstens kann ein Auftrag zu mehr als einem Ergebnis führen, sodass diese miteinander vermischt werden. Aber
vor allem, weil jedes Ergebnis aus mehreren Teilen bestehen kann, deren Anzahl nicht bekannt ist
vorab erstellt werden und nicht in einer Datei zusammengemischt werden können. Auch dies ist typisch für die
Binärdaten, die Bilder zurückgeben – ein Aufruf kann viele Bilder erzeugen.

Die Option „-r“ ruft alle verfügbaren Ergebnisse ab und behandelt sie wie durch das „?“ beschrieben.
Format unten.

Die Option „-R“ verfügt über eine durch Kommas getrennte Liste von Ergebnisnamen, jeder der Namen kann sein
entweder ein einfacher Name (wie in der „Ergebnisspezifikation“ angegeben, die mit „-o“ erhältlich ist)
oder „-O“-Optionen) oder ein durch Gleichheitszeichen getrenntes Namens-/Formatkonstrukt, das vorschlägt, was zu tun ist
mit dem Ergebnis. Die Möglichkeiten sind:

Ergebnisname
Das angegebene Ergebnis wird auf der Standardausgabe gedruckt.

Ergebnisname=Dateiname
Das angegebene Ergebnis wird in der angegebenen Datei gespeichert.

Ergebnisname=@
Es speichert das gegebene Ergebnis in einer Datei, deren Name automatisch erfunden wird, und es
garantiert, dass beim nächsten Aufruf nicht derselbe Name verwendet wird.

result=name=@template
Es speichert das gegebene Ergebnis in einer Datei, deren Name durch die „Vorlage“ vorgegeben wird. Der
Die Vorlage kann mehrere Zeichenfolgen enthalten, die vor der Verwendung als Vorlage ersetzt werden
Dateiname:

Beliebig '*'
Wird durch eine eindeutige Nummer ersetzt

$ANALYSIS oder ${ANALYSIS}
Wird durch den aktuellen Analysenamen ersetzt

$RESULT oder ${RESULT}
Wird durch den aktuellen Ergebnisnamen ersetzt

Wie erkennt man, was mit den Ergebnissen zu tun ist? Jeder Ergebnisname

Zusätzlich kann eine Vorlage als Umgebungsvariable angegeben werden
„RESULT_FILENAME_TEMPLATE“. Eine solche Variable wird für jedes Ergebnis in ihrem Format verwendet
eine einfache "?" oder „@“-Zeichen.

Ergebnisname=?
Es entscheidet zunächst, ob das gegebene Ergebnis binär ist oder nicht. Dann ergeben sich die binären Ergebnisse
werden in lokalen Dateien gespeichert, deren Namen automatisch erfunden werden, die anderen Ergebnisse
werden an die Standardausgabe gesendet.

result-name=?template
Dasselbe wie oben, aber die Dateinamen für Binärdateien werden aus den angegebenen abgeleitet
Vorlage (unter Verwendung der gleichen Regeln wie oben beschrieben).

Beispiele:

-r
-R-Bericht
-R-Bericht, Outseq
-R Graphics_in_PNG=@
-R Graphics_in_PNG=@$ANALYSIS-*-$RESULT

Beachten Sie, dass die Ergebnisformatierung in Zukunft durch die Verwendung vorhandener Datentypen erweitert wird
Parser in Bioperl.

FEEDBACK

Postsendung Listen
Benutzerfeedback ist ein wesentlicher Bestandteil der Weiterentwicklung dieses und anderer Bioperl-Module. Senden
Ihre Kommentare und Anregungen vorzugsweise an die Bioperl-Mailingliste. Deine Teilnahme
wird sehr geschätzt.

[E-Mail geschützt] - Allgemeine Diskussion
http://bioperl.org/wiki/Mailing_lists - Über die Mailinglisten

Reporting Fehler
Melden Sie Fehler an das Bug-Tracking-System von Bioperl, damit wir die Fehler und ihre Fehler im Auge behalten können
Auflösung. Fehlerberichte können über das Web eingereicht werden:

http://redmine.open-bio.org/projects/bioperl/

Verwenden Sie bp_panalysis.plp online über die Dienste von onworks.net