Pflichtenheft

Version 35, last updated by Puzi at May 06, 2007 14:41 UTC

1. Zielbestimmung

Wir entwickeln einen Viewer für zirkuläre Bakteriengenome, [IO] die bereits annotiert im GenBank Format vorliegen.

Musskriterien:

[IO]GenBank Files können geladen werden
[GUI] Hierzu soll unter dem ersten Menüpunkt „Datei“ der Unterpunkt „Import“ existieren. [IO finden wir schon zu detailliert, eher unter funktionen]
[Vis]DNA graphisch darstellen (zirkulär oder linear)
[GUI] Nach dem Import soll das importierte Genom zunächst in einem festen "Hauptfenster" als zirkuläres Genom dagestellt sein.
[Vis]die lineare Darstellung muss zoombar und verschiebbar sein
[Vis]bestimmte Bereiche können ausgewählt werden
[GUI] wählt man einen bestimmten Bereich aus so öffnet sich neben dem Hauptfenster ein sepaarates Fenster in dem der ausgewählte Bereich entsprechend vergößert dargestellt wird. Das Hauptfenster mit dem kompletten Genom bleibt aber erhalten
[Vis]einige Features des Genoms können farbig hervorgehoben werden [GUI] diese Farbgebung kann vom Benuzer jederzeit manuell geändert werden
[IO]Ausschnitte der DNA können im FastA Format exportiert werden ~~[GUI] Hierzu soll unter dem ersten Menüpunkt „Datei“ der Unterpunkt "Export" realisiert werden.~~
[IO]Sind Proteine gespeichert, sollen diese ebenfalls im FastA Format exportiert werden können
[IO]Bilder können in den Formaten Bitmap und JPEG gespeichert werden ~~[GUI] weshalb unter dem ersten Menüpunkt „Datei“ auch der Unterpunkt "Speichern" existieren soll.~~
[IO]Es gibt die Statistikfunktionen GC-Gehalt, GC3, GCSkew, CodonUsage~~[GUI] diese Statistiken sollen im unteren Bereich des Programmfensters in einer aufgeführt und durch einen Mausklick auf die gewünschte Statistik neben der Liste angezeigt werden können~~
[VIS] zwei Genome können in einer gemeinsamen Ansicht verglichen werden

Wunschkriterien:

evtl soll die zirkuläre Ansicht drehbar werden, damit man, z.B. beim Vergleich zweier Genome, die entsprechenden Stellen gleich ausrichten kann
[GUI] Das Hauptfenster und die Auswahlansichten können nebeneinander ausgereichtet und nach Wunsch angeordnet werden
Während man in der linearen Ansicht ist, kann in einer kleineren, zirkulären Übersicht angezeigt werden, wo im Genom man sich gerade befindet
[GUI] Man kann mehrere komplette Genome anschauen, allerdings nicht im gleichen Fenster. Da die Fenster aber variabel sind kann man sich die gwünschten Genome manuell nebeneinander anordnen
[IO]Druckfunktionen erlauben die Ausgabe der Bilder und Statistiken Hierzu wird es einen Unterpunkt "Drucken" unter dem ersten Menüpunkt "Datei" geben
[IO]Weitere noch zu spezifizierende Statistikfunktionen werden implementiert
[VIS] der Maßstab kann von Kb auf Minuten umgestellt werden
[VIS] der Benutzer soll auch die Reihenfolge der Ringe in der zirkulären Ansicht wählen können (z.B. tRNA oder rRNA in eigenen Ringen anzeigen und nicht über den Genen, GC-Skew nach außen, in der Vergleichenden Ansicht entweder: Strang1Genom1 - Strang2Genom1 - Strang1Genom2 - Strang2Genom2 - GCSkew Genom1 - GCSkew Genom2 oder eben die GC-Skews direkt beim jeweiligen Genom
[VIS] im Zoom-Modus kann man die Gene nach GC-Gehalt einfärben
[VIS] durch Ziehen mit der Maus soll in der zirkulären oder linearen Übersicht ein Bereich ausgewählt und in einer gezoomten linearen Ansicht angezeigt werden.
[IO]Es ist möglich eigene Funktionen als Plug-In zu laden
[IO für Visualisierung]Auswahl der Ausschnitte zum Speicher/Bearbeiten mit der Maus
[IO]Die Header der FastA Dateien werden manuell oder automatisch generiert
[IO]Start über Kommandozeilenparameter (direktes Dateiladen)
[IO - für Visualisierung/GUI]Profile für Farbwahl etc.[GUI] Die Farbgebung der funktionellen bzw. annotierten Bereiche eines importierten Genoms kann durch den Anwender jederzeit leicht geändert werden.
Vergleiche sollen auf 3 Wege möglich sein:

Abgrenzungskriterien:

das Genom muss bereits annotiert sein, wir zeigen nur die in der GenBank-Datei enthaltenen Informationen an und werten nichts selber aus (Ausnahme: Statistiken)
es können nur zirkuläre Prokaryotengenome dargestellt werden, die höchstens ca 10 MB lang sind
von einem proteincodierenden Gen kann auf Wunsch die AS-Sequenz angezeigt werden, aber nicht deren Sekundärstruktur o.ä.
es können nur GenBank Dateien eingelesen werden
[IO]Es gibt keine Fehlerkorrektur für Daten, fehlerhaft formatierte Dateien können nur teilweise verarbeitet werden

2. Produkteinsatz

[IO](Das Produkt wird von Informatikern auf Bugs, Stabilität, Userfreundlichkeit, Geschwindigkeit, Rechtschreibung u.ä. zur Festlegung einer Note für BioInfo Studenten getestet)
[IO]Das Produkt soll in der Genomforschung zur visuellen Analyse von GenBank Daten dienen, dabei sind vor allem wichtige Features und deren Lage anzuzeigen
[IO]Das Produkt ist für Biologen und Bioinformatiker gedacht, (die lediglich Mausschubser sind) die nicht in das Programm eingearbeitet werden
[IO]Es ist für den internationalen Einsatz geplant und daher komplett in englischer Sprache gehalten
[IO]Das Programm wird häufig neu gestartet, allerdings sind auch mehrere Analysen nacheinander möglich

3. Produkt-Umgebung

[IO]Die Software läuft auf einer JavaVM der Version 1.5+ und damit auf jedem Betriebssystem
[IO]Die Software wird auf einem heute handelsüblichen Desktop PC getestet
[IO]Zur Nutzung sind Maus und Tastatur notwendig
[IO]Der Austausch von Daten mit anderen Programmen findet lediglich auf Datei Ebene statt

4. Produkt-Funktionen

4.1 Datei Handling [IO]

4.1.1 Laden von GenBank Dateien
Das Programm liest ein Prokaryoten Genom mit maximaler Länge 10mbp aus einer Datei im GenBank-Format ein und stellt alle darin enthaltenen Informationen zur Verfügung.
Die Datei wird anhand ihres Dateinamens und Pfades charakterisiert.
Zu diesen Informationen gehören DNA-Sequenz, Referenzen und weitere Details, wie z.B. bereits identifizierte Gene.

4.1.1.1 Laden von mehr als 2 Dateien
Es werden lediglich 2 Genome gleichzeitig bearbeitet. Daher wird nach der 2. Datei für jedes zusätzlich zu ladende Genom ein Auswahldialog angezeigt, über den der Benutzer entscheidet, welches der beiden
bisherigen Genome ersetzt werden soll.

4.1.2 Speichern von DNA-Sequenzen
Diese Funktion erfordert die Eingabe eines Headers, Angabe der Position der Anfangs- und Endbasen sowie eines Dateinamens.
Die entsprechende Teilsequenz der DNA inklusive Anfangs und Endbase wird im FastA Format in die Datei geschrieben.

4.1.3 Speichern von Protein Sequenzen
Nach der Eingabe eines vorhandenen Locus-Tags oder einer existierenden ProteinID wird die entsprechende Protein Sequenz im FastA Format in einer anzugebenden Datei gespeichert.
Der Header dieser Datei kann entweder frei gewählt werden oder entspricht dem Locus-Tag.

4.1.4 Speichern des Textinhaltes des aktuellen Fensters
Der Benutzer kann den Inhalt des aktuellen Textfensters (Analyse oder weiterführende Informationen eines Features) in einer Textdatei, deren Namen und Pfad er wählt, speichern.

4.1.5 Speichern aller Analysen
Der Benutzer kann diese Funktion ausführen und einen Dateinamen angeben.
Dann werden alle bisher ausgeführten Analysen in der zeitlichen Reihenfolge, getrennt durch eine Leerzeile in der angegebenen Datei gespeichert.

4.1.6 Speichern eines aktuellen Bildinhaltes
Der Benutzer kann die gerade dargestellte Anzeige in einer Bilddatei im JPEG oder Bitmap Format mit einem selbst gewählten Dateinamen abspeichern.

4.2. Darstellung des Genoms [Vis]

Es sollte drei Buttons zur Auswahl der drei verschiedenen Ansichten geben: "Zirkuläre Ansicht", "Lineare Ansicht", "Zoom-Modus". (VIS an GUI: können wir die verschiedenen Ansichten vielleicht als verschiedene Tabs machen? das wäre doch ganz praktisch und man muss nicht die ganze zeit die verschiedenen fenster verschieben )Klar

4.2.1. Zirkuläre Ansicht

Das eingelesene Genom wird zunächst in einem Hauptfenster welches wärend der Bearbeitung eines Projektes permanent erhalten bleibt zirkulär und groß angezeigt. Den äußersten Ring bildet ein "Maßstab", auf dem in 500 Kb-Schritten die einzelnen Punkte beschriftet sind. Die Gesamtlänge des Genoms wird hier auch ersichtlich sein, nämlich am 0Kb/Gesamtlänge-Punkt. Der 5'->3' und der 3'->5' Strang werden räumlich getrennt dargestellt. So kann man auch erkennen, auf welchem Strang die Gene für die tRNAs und rRNAs liegen, obwohl die Symbole für diese Features keine Pfeilform haben. Die Gene werden als hellblaue, breite Pfeile in die jeweilige Strangrichtung dargestellt. In der zirkulären Übersicht wird wahrscheinlich nichts genaueres zu erkennen sein. Über, bzw. zwischen den Genen werden auf dem gleichen Ring die rRNAs als grüne Punkte und die tRNAs als orangene Kreuze gezeigt. Da diese nicht sehr groß sind reicht ein punktförmiges Symbol aus. Operons kommen in den GenBank Dateien nur selten vor, falls doch einmal welche dabei sind sollen sie als farbiger Rahmen um die entsprechenden Gene angezeigt und mit dem Namen des Operons beschriftet werden. Der Origin of Replication wird ein großer roter Strich durch das Chromosom, wie ein Zeiger einer Uhr.
Im Zentrum steht am Anfang nur der Name des Bakteriums. Dieses Feld kann der Benutzer aber auch jederzeit ändern und z.B. die Gesamtlänge oder einen selbst eingegebenen Text anzeigen.

4.2.2. Lineare Ansicht

Durch Drücken des entsprechenden Knopfes wird die lineare Übersicht in einem neuen Tab geöffnet. Diese besteht immer aus 10 Zeilen, die je nach Größe des Genoms bis zu 1Mb lang sind. [GUI] Welche dann allerdings in einem Nachbarfenster erscheint

4.2.3. Zoom-Modus

Ist dieser Knopf gewählt, wird in einem neuen Tab eine zirkuläre Übersicht des Genoms angezeigt, darunter befindet sich eine Zeile der linearen Ansicht. Durch Anklicken eines Bereiches im zirkulären Genom wird der angeklickte Bereich in der Zeile angezeigt und in der zirkulären Übersicht der Ausschnitt markiert. In dieser Ansicht können viel mehr Details dargestellt werden als in den Übersichten, weswegen der Benutzer wahrscheinlich meistens die Zoom-Ansicht nutzen wird. Auch durch Anklicken eines Punktes in der zirkulären Übersicht soll der Zoom-Modus direkt geöffnet werden und die Umgebung des angeklickten Elements (z.B. tRNA) angezeigt werden.

4.3. Farbgebung [Vis]

Die verschiedenen Bereiche (z.B. tRNA, versch. Gengruppen) des Genoms werden in verschiedenen Farben angezeigt. Die Farbgebung kann der Benutzer selbst wählen. ([vis] wir denken uns das so: für die einzelnen features soll es Buttons geben, wenn die Buttons gedrückt sind wird das entsprechende Feature angezeigt. Durch Rechtsklick auf einen Button kann die Farbe für dieses Feature ausgewählt werden. Außerdem sollte es vielleicht im Menü (Einstellungen oder so) ein Übersichtsfenster geben, wo man alle Farben für alle Features zuweisen kann) [GUI] Hierzu soll eine feste Symbolleiste neben den Menüpunkten erstellt werden in der vom Benutzer der gewünschte Teilbereich sowie die gewünschte Farbe gewählt werden können.Hier kann vom Benutzer ausgewählt werden ob die Farbänderung das gesamte Projekt oder nur das von Ihm gerade bearbeitete Fenster betrifft.Des Weiteren kann ein spezieller Teilbereich auch durch Rechtsklick ausgewählt und die Farbe beliebig geändert werden ohne dass es alle identischen funktionellen Gruppen betrifft.

4.4. Formgebung der Features

Siehe Skizze

4.4. Interaktive Darstellung [Vis]

4.4.1. Ansicht wechseln
Der Benutzer kann jederzeit zwischen linearer und zirkulärer Ansicht und Zoom-Modus wechseln. Durch Anklicken eines Punktes in der zirkulären Ansicht wird auch der Zoom-Modus geöffnet.

4.4.2. Features anzeigen
Man muss im Menü verschiedene Buttons für die Features haben. Diese Werden nur angezeigt, wenn die entsprechenden Buttons gedrückt sind.

Selektierbare Features:

- rRNA
- gene
- operons
- oriR ([IO] Problem: Entweder oriR ist bekannt, dann ist das File danach ausgerichtet, oder er ist unbekannt, dann ist es für uns algorithmisch unmöglich ihn festzustellen)
- tRNA

Selektierbare Statistiken:

- GC-Skew
- relativer GC-Gehalt
- GC3

4.4.3. Eigenschaften des Gens einblenden

Dies Betrifft den Zoom-Modus. In der zirkulären Übersicht müssen die Gene erst angeklickt werden (damit sich der Bereich im Zoom-Modus öffnet), dann kann man wie unten beschrieben die Eigenschaften des Gens anzeigen lassen.
Ohne spezielle Auswahl wird der Benutzer nur den Gennamen und die Lage auf dem Strang (durch Richtung der Pfeile) sehen.
Verharrt der Benutzer mit dem Cursor längere Zeit über einem bestimmten Gen, werden weitere Eigenschaften in einer Toolbox eingeblendet. Dies sind z.B. die genaue Länge und Position, der Name des Gens, das Produkt, der locus-tag.
Bei einem Doppelklick auf das Gen, werden zusätzliche Informationen angezeigt, z.B. AS-Sequenz, sonstige Beschreibung aus der GenBank Datei, evtl Links. Diese Informationen müssen in einem neuen Fenster geöffnet werden.

4.5. Lupenfunktion [Vis]

Im Zoom-Modus kann zwischen verschiedenen Zoomstufen (10, 25, 50, 100 KB) für die angezeigte Zeile gewählt werden. Außerdem kann man eine bestimmte Anzahl von Kilobasenpaaren nach rechts oder links springen (z.B. 10, 50, 100), sowie stufenlos Scrollen.
In der vergleichenden Ansicht können die beiden linear angezeigten Genome unabhängig voneinander gescrollt werden, sodass man Abschnitte, die man vergleichen möchte, direkt übereinander ausrichten kann
[GUI] Über eine gesonderte Symbolleiste „Werkzeuge“ kann eine Lupe ausgewählt werden, mit der man dann in das zirkuläre bzw. lineare Genom hineinzoomen kann.
Zieht man die Lupe über einen speziellen Teilbereich so wird der gewählte Bereich vergrößert/verkleinert.

4.6. Suchfunktion

Durch Eingabe einer Gen-ID oder des locus-tags kann zu einem bestimmten Gen gesprungen werden.
Durch Eingabe eines Bereichs wird es möglich sein, direkt dorthin zu springen. Der Ausgewählte Bereich wird wieder in der zirkulären Übersicht markiert.

[GUI]

Über eine gesonderte Symbolleiste „Werkzeuge“ kann ein Auswahlviereck erstellt werden um manuell einen Teilbereich auszuwählen, welcher dann in einem neuen „Bearbeiten“-Fenster entsprechend größer und auf Wunsch linear dargestellt wird. In diesem Bearbeitungsfenster sind alle Aktionen wie auch im Hauptfenster möglich.([VIS] das fällt unter zoomfunktion. muss man dafür überhaupt ein werkzeug auswählen? kann man nicht einfach mit der maus ziehen? außerdem finden wir, dass der ausgewählte bereich immer linear dargestellt werden sollte, zirkulär gezoomt macht ja irgendwie keinen sinn)

In der Symbolleiste „Werkzeuge“ existiert ein Such-Fenster in der man speziell nach funktionellen Bereichen suchen kann welche einem als Liste angezeigt wird, aus der man einen oder mehrere gewünschte Teilbereiche auswählen kann oder auch über den Namen eines funktionellen Bereichs innerhalb des geöffneten Projektes den gewünschten Bereich suchen und in einem neuen „Bearbeiten“-Fenster dargestellt bekommt.(wie ist das mit der Liste gemeint? Gen-Id und locus-tag sind ja immer eindeutig, da braucht man also keine Liste. sollen wir irgendwie erlauben, nach gennamen zu suchen, die der benutzer gar nicht genau weiß und dann mögliche "Treffer" anzeigen? ich weiß gar nicht wie man sowas machen soll/kann, ist das nicht unheimlich kompliziert? oder meint ihr es so, dass man sagt: ich will jetzt eine Liste mit allen tRNAs sehen!).

4.6. Vergleichende Darstellung

[Vis] Es kann jederzeit ein zweites Genom geladen werden. Dieses wird dann wie das erste zunächst in einem eigenen Tab als zirkuläre Übersicht dargestellt. Für dieses stehen natürlich die gleichen Funktionen wie für das erste Genom zur Verfügung. Es muss allerding auch eine Option geben, zwei gewünschte Tabs zusammenzuführen. Die beiden Genome werden dann in einem einzigen Fenster angezeigt. Sind beide linear, werden sie in der vergleichenden linearen Ansicht gezeigt. Dabei befinden sich die Genome in verschiedenen Ringen im selben Kreis. Dies funktioniert nur bei etwa gleich großen Genomen gut. Ist die größe unterschiedlich ist der Ring so groß wie das längere Genom, der fehlende Bereich wird im kürzeren durch einen schwarzen Balken ausgefüllt.
Sind beide Genome in der linearen Ansicht, wird auch die vergleichende Ansicht linear. Diese besteht wieder aus 10 Zeilen, wobei 5 von jedem Genom stammen und abwechselnd untereinander stehen. Die beiden DNAs können unabhängig voneinander oder gemeinsam gescrollt werden und nur gemeinsam gezoomt. Wenn man zoomt werden allerdings Teile des Genoms nicht mehr angezeigt, die Ansicht wird nie länger als 10 Zeilen.

(Siehe Skizze)

(an GUI: können wir diese teil-vergleiche vielleicht auf die wunschliste nehmen, ich glaube nicht, dass wir dafür auf jeden fall genug zeit haben)Sind jetzt in Wunschkriterien drin

4.7 Statistikfunktionen [IO]

4.7.1Allgemeine Informationen
Diese Funktion liefert den Locus Tag und Länge des Genoms, sowie die Anzahl der annotierten Features.

4.7.2 GC- Gehalt der DNA
Bei Ausführen dieser Funktion, erhält der Benutzer über ein Textfenster oder eine Infobox[IO an GUI – bitteaussuchen]den prozentualen Gehalt an Guanin und Cytosin in der DNA mitgeteilt.

4.7.3 Lokaler GC – Gehalt der DNA
Beim Ausführen dieser Funktion gibt der User eine Breite an, in der der lokale GC Gehalt prozentual ermittelt wird. Diese Fenster überlappen sich nicht. Der Benutzer erhält eine graphische Darstellung dieser lokalen Anteile. [IO an GUI – bitte bestätigen]

4.7.4 GC3 Plot
Der Benutzer kann eine Frame Size eingeben und erhält als Ausgabe 2 Graphen, die den GC3 Plot für beide Leserichtungen darstellen.[IO an GUI – bitte bestätigen]

4.7.5 GC-Skew
Der Benutzer gibt eine Frame Size an und erhält als Ausgabe einen Graphen, der den GC Skew darstellt.[IO an GUI – bitte bestätigen]

4.7.6 Codon Usage in einem Protein
Wird diese Funktion aufgerufen, so muss der Benutzer den Locus Tag oder die Protein ID eingeben und erhält als Ergebnis eine Tabelle zur absoluten Nutzung der Codontripletts sowie eine Tabelle zur relativen Nutzung der Codontripletts einer Aminosäure.
[IO an GUI – Eventuell direkt aus dem Fenster der Infos wählbar?]
[IO an Vis – Vielleicht ne kleine Graphik dazu wenn ihr Zeit habt]

4.7.7 Codon Usage in einem Bereich
Die Funktion erstellt 2 Tabellen zur absoluten Nutzung der Codons und zur relativen Nutzung der redundanten Codons einer Aminosäure für Bereiche. Stoppcodons werden in dieser Tabelle ebenfalls aufgeführt.
Diese Bereiche werden eingegeben über[IO an GUI – ein schickes Fenster?]eine Zeile, die durch Kommas getrennt Einzelbereiche enthält, die aus einem Start und einem Endindex bestehen. Diese sind durch einen Bindestrich getrennt.
Zusätzlich existieren die beiden Variablen „begin“ und „end“, die den Beginn bzw. das Ende der gespeicherten DNA Sequenz markieren.
Ist der Zielindex größer als der Startindex, so wird die invers komplementäre Sequenz übersetzt.
Die Bereiche dürfen sich überlappen.
Übersetzt wird vom Startindex als Beginn des ersten Codons bis maximal zum Zielindex. Liegt dieser in einem unvollständigen Codon, so wird dieses nicht übersetzt.

4.7.8 Codon Usage für Open Reading Frames
Diese Funktion erstellt 6 Tabellen, die die absolute Nutzung der Codon Tripletts sowie die prozentuale Nutzung für die einzelnen Aminosäuren in Bereichen enthalten.
Jede Tabelle repräsentiert dabei einen der drei ORF, sowie den Sinn- bzw. Komplementärstrang..
Als Eingabe erstellt der User durch Kommata getrennte Paare aus Anfangs- und Zielindizes, die durch einen Bindestrich getrennt werden.
Als Variablen für den Sequenzanfang und das Sequenzende existieren „begin“ und „end“.
Diese Bereiche dürfen sich überlappen, jeder Bereich wird dabei einzeln behandelt, verwendet wird jedoch ein globales Leseraster.

4.7.9 Analysen von Fensterinhalten
Der Benutzer kann Analysen für den aktuellen Fensterinhalt sofort beginnen.
Zur Verfügung stehen:
- GC Gehalt
- Relativer GC Gehalt (erfordert die Eingabe einer Analysefenstergröße)
- GC Skew (benötigt ebenfalls eine Analysefenstergröße)
- GC3 Plot
- Codon Usage für Open Reading Frames
Die dafür erforderlichen Daten über Beginn und Ende ermittelt das Programm eigenständig[IO für GUI/Vis].

5. Produkt-Daten

([IO] keine Ahnung)

6. Produkt-Leistungen

([IO] keine Ahnung)

7. Benutzerschnittstelle

[IO] Der Benutzer interagiert mit dieser Software mittels Tastatur und Maus.
Als Ausgabegeräte dienen Monitor und evt. Drucker.

8. Qualitätszielbestimmung

[IO] Unsere Software sollte:

nicht abstürzen
aussagekräftige Fehlermeldungen liefern
in akzeptabler Zeit reagieren bzw. Fortschrittsmeldungen liefern
intuitiv bedienbar sein
....

9. Globale Testfälle

([IO] keine Ahnung)

10. Entwicklungs-Konfiguration

([IO] keine Ahnung)