Recent changes to Pipeline

Pipeline modified by Martin S. Lindner

Martin S. Lindner — Wed, 03 Dec 2014 16:49:10 -0000

--- v6
+++ v7
@@ -10,3 +10,31 @@
 The window is divided into four panels. The upper left panel shows the MicrobeGPS __Pipeline__, where all seven steps are listed. A red light means that the step is not yet completed, a yellow light means that the step is currently running, a green light means that the step is complete. A red X indicates that a step failed. To run a step, its previous step must be completed (green light). Clicking on one step shows its __Parameters__ in the upper right panel. These parameters can be changed as long as the step has a red light. A __Parameter Description__ is shown in the lower left panel. Progress messages, errors and other notifications are shown on the __Console__ in the lower right panel.

 You can eiter preconfigure all steps and then run the complete pipeline from the beginning to the end, or you can each step separately. The former has the advantage that you can start your analysis and leave the program alone while it is running. The latter allows you to check the progress of each step such that you can, for example, rerun a step with a different parameter setting.
+
+Pipeline parameters
+-------------------
+
+### Raw filtering ###
+
+__Minimum Genome Support__ discards all reference sequences that obtained less than the specified number of reads in total (including shared reads). A higher threshold reduces the number of genomes to be analyzed (lower run time) at the risk of discarding genomes of low abundant species.
+
+__Max. Read Matches__ discards all reads having matches to more than the specified number of genomes. These reads are uninformative for the clustering step of MicrobeGPS.
+
+__Max. Read Mapping Error__ filters out all read mappings with an error above the specified value. Here, the error is defined as the fraction of mismatches in the total read length.
+
+
+### Quality Filtering ###
+__Min. Number Unique Reads__ discards references with less than the specified number of unique reads. Here, reads are considered as _unique reads_ when they were mapped uniquely to this reference. Reads are also considered as _unique_ when there are multiple matches to the same reference (i.e. also on different chromosomes). A higher threshold can further reduce the amount of data to be analyzed, especially in datasets with many noisy read mappings (e.g. when a large fraction originates from completely uncharacterized organisms).
+
+__Max. Homogeneity__ puts a threshold on the homogeneity of the distribution of the reads on the genome. The homogeneity of the read distribution over the genome is measured by comparing the read distribution to a uniform distribution using the Kolmogorov-Smirnov test statistic. Organisms with a test statistic higher than the specified value are discarded. Note, that this ist not a p-value, but the raw Kolmogorov-Smirnov test statistic!
+
+
+### Calculate Candidates ###
+
+__Min. Genome Validity__ discards all organisms below the specified validity threshold. The validity is the estimated fraction of the genome that could be covered by reads. This threshold should be kept low (or even zero) when many uncharacterized organisms are expected in the dataset. Higher thresholds may be used to only keep very certain candidates.
+
+__Coverage Similarity__ sets the characteristics of the so-called Core Reads (CR). These are reads mapping to genomes with similar genome coverage depth. This parameter defines the maximum relative coverage differences of all target genomes of a read. A lower coverage similarity parameter requires a narrower range of measured coverages of all genomes a read maps to. This yields to less CR in total. 
+
+__Fraction Shared USR__  defines in the clustering step the minimum required fraction of CR (or Unique Source Reads USR) shared with another reference to be put in the same cluster. This threshold prevents the clustering scheme from accidentally merging two reference in the same cluster that have by chance a similar coverage. Lower thresholds should only be set when really required.
+
+__Fraction Shared Reads__ allows putting references in the same cluster that were not joined via the shared CR. Here, the references are required to have a fraction of reads mapping to both references set by this parameter.

Pipeline modified by Martin S. Lindner

Martin S. Lindner — Tue, 01 Apr 2014 13:51:54 -0000

--- v5
+++ v6
@@ -5,7 +5,7 @@

 The MicrobeGPS Pipeline window shows the analysis pipeline and allows you to adjust the analysis parameters. You can either run each step separately or run all steps at once.

-[[img src=Pipeline.jpg alt=MicrobeGPS Pipeline]]
+[[img src=Pipeline.jpg]]

 The window is divided into four panels. The upper left panel shows the MicrobeGPS __Pipeline__, where all seven steps are listed. A red light means that the step is not yet completed, a yellow light means that the step is currently running, a green light means that the step is complete. A red X indicates that a step failed. To run a step, its previous step must be completed (green light). Clicking on one step shows its __Parameters__ in the upper right panel. These parameters can be changed as long as the step has a red light. A __Parameter Description__ is shown in the lower left panel. Progress messages, errors and other notifications are shown on the __Console__ in the lower right panel.

Pipeline modified by Martin S. Lindner

Martin S. Lindner — Tue, 01 Apr 2014 13:50:37 -0000

Pipeline modified by Martin S. Lindner

Martin S. Lindner — Tue, 01 Apr 2014 13:49:57 -0000

--- v3
+++ v4
@@ -5,7 +5,7 @@

 The MicrobeGPS Pipeline window shows the analysis pipeline and allows you to adjust the analysis parameters. You can either run each step separately or run all steps at once.

-Put image here.
+[[img src=Pipeline.jpg alt=MicrobeGPS Pipeline]]

 The window is divided into four panels. The upper left panel shows the MicrobeGPS __Pipeline__, where all seven steps are listed. A red light means that the step is not yet completed, a yellow light means that the step is currently running, a green light means that the step is complete. A red X indicates that a step failed. To run a step, its previous step must be completed (green light). Clicking on one step shows its __Parameters__ in the upper right panel. These parameters can be changed as long as the step has a red light. A __Parameter Description__ is shown in the lower left panel. Progress messages, errors and other notifications are shown on the __Console__ in the lower right panel.

Pipeline modified by Martin S. Lindner

Martin S. Lindner — Tue, 01 Apr 2014 13:42:54 -0000

Pipeline modified by Martin S. Lindner

Martin S. Lindner — Tue, 01 Apr 2014 13:42:28 -0000

Pipeline modified by Martin S. Lindner

Martin S. Lindner — Tue, 01 Apr 2014 13:42:16 -0000

[Home]

MicrobeGPS Pipeline

The MicrobeGPS Pipeline window shows the analysis pipeline and allows you to adjust the analysis parameters. You can either run each step separately or run all steps at once.

Put image here.

The window is divided into four panels. The upper left panel shows the MicrobeGPS Pipeline, where all seven steps are listed. A red light means that the step is not yet completed, a yellow light means that the step is currently running, a green light means that the step is complete. A red X indicates that a step failed. To run a step, its previous step must be completed (green light). Clicking on one step shows its Parameters in the upper right panel. These parameters can be changed as long as the step has a red light. A Parameter Description is shown in the lower left panel. Progress messages, errors and other notifications are shown on the Console in the lower right panel.

You can eiter preconfigure all steps and then run the complete pipeline from the beginning to the end, or you can each step separately. The former has the advantage that you can start your analysis and leave the program alone while it is running. The latter allows you to check the progress of each step such that you can, for example, rerun a step with a different parameter setting.