From cba90259838fb7ae2a292b06471a71af7adaf040 Mon Sep 17 00:00:00 2001 From: hanna Date: Wed, 17 Jun 2009 16:28:45 +0000 Subject: [PATCH] More package-level documentation. git-svn-id: file:///humgen/gsa-scr1/gsa-engineering/svn_contents/trunk@1030 348d0f76-0448-11de-a6fe-93d51630548a --- .../sting/gatk/executive/package.html | 10 ++++++++++ .../sting/gatk/iterators/package.html | 10 ++++++++++ java/src/org/broadinstitute/sting/gatk/package.html | 11 +++++++++++ .../broadinstitute/sting/gatk/refdata/package.html | 10 ++++++++++ .../broadinstitute/sting/gatk/walkers/package.html | 13 +++++++++++++ 5 files changed, 54 insertions(+) create mode 100644 java/src/org/broadinstitute/sting/gatk/executive/package.html create mode 100644 java/src/org/broadinstitute/sting/gatk/iterators/package.html create mode 100644 java/src/org/broadinstitute/sting/gatk/package.html create mode 100644 java/src/org/broadinstitute/sting/gatk/refdata/package.html create mode 100644 java/src/org/broadinstitute/sting/gatk/walkers/package.html diff --git a/java/src/org/broadinstitute/sting/gatk/executive/package.html b/java/src/org/broadinstitute/sting/gatk/executive/package.html new file mode 100644 index 000000000..5c9d96264 --- /dev/null +++ b/java/src/org/broadinstitute/sting/gatk/executive/package.html @@ -0,0 +1,10 @@ + + + + + + +Manages individual analyses by shattering data, pushing individual shards to the traversal engines, and gathering results and presenting them to the user. + + + diff --git a/java/src/org/broadinstitute/sting/gatk/iterators/package.html b/java/src/org/broadinstitute/sting/gatk/iterators/package.html new file mode 100644 index 000000000..d14105052 --- /dev/null +++ b/java/src/org/broadinstitute/sting/gatk/iterators/package.html @@ -0,0 +1,10 @@ + + + + + + +Tools for iterating over different views of GATK data. + + + diff --git a/java/src/org/broadinstitute/sting/gatk/package.html b/java/src/org/broadinstitute/sting/gatk/package.html new file mode 100644 index 000000000..677a9b96f --- /dev/null +++ b/java/src/org/broadinstitute/sting/gatk/package.html @@ -0,0 +1,11 @@ + + + + + + +Provides map/reduce application framework highly optimized for +analysis of sequencing data. + + + diff --git a/java/src/org/broadinstitute/sting/gatk/refdata/package.html b/java/src/org/broadinstitute/sting/gatk/refdata/package.html new file mode 100644 index 000000000..0c6a55319 --- /dev/null +++ b/java/src/org/broadinstitute/sting/gatk/refdata/package.html @@ -0,0 +1,10 @@ + + + + + + +Reads and preprocesses the various types of data represented by the +GATK. + + diff --git a/java/src/org/broadinstitute/sting/gatk/walkers/package.html b/java/src/org/broadinstitute/sting/gatk/walkers/package.html new file mode 100644 index 000000000..9f3a8983e --- /dev/null +++ b/java/src/org/broadinstitute/sting/gatk/walkers/package.html @@ -0,0 +1,13 @@ + + + + + + +Runs the desired analysis on the smallest meaningful subset of the +dataset. Traditionally, the smallest subset is either an individual +locus or read. + + + +