CAPE
From GersteinInfo
| (18 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| - | + | [[File:CAPE.png]] | |
| - | + | =Coupled Analysis of Polymerase and Expression (CAPE)= | |
| + | CAPE Is designed with two primary goals in mind. The first is to associate transcription factor binding site data from next-generation sequencing experiments such as ChIP-Seq with a set of genomic features such as transcription start sites, transcription end sites, etc. The second aim is to classify transcripts in a genome based on levels of transcription factor binding at the promoter vs the expression level of the transcript. CAPE is designed to work with many of the formats employed by large consortia such as NHGRI’s ENCODE and modENCODE consortia. | ||
| - | |||
| + | CAPE is written in Java and requires Java version 1.6 or higher. The Java runtime environment (JRE) must be installed. If the JRE is not installed (i.e. typing “java –version” at the command line does not produce a version number or the version number is < 1.6), an updated version of the Java Runtime Environment can be downloaded from the [http://www.oracle.com/technetwork/java/index.html Java website]. | ||
| - | |||
| - | |||
| - | |||
| - | == | + | ==Get the Program== |
| + | CAPE programs are distributed as executable JAR files. Please see the Users Guide for more information. | ||
| - | [http://archive.gersteinlab.org/proj/ | + | [http://archive.gersteinlab.org/proj/CAPE/bin/CAPE-analyze.jar CAPE-analyze] |
| - | [http://archive.gersteinlab.org/proj/ | + | [http://archive.gersteinlab.org/proj/CAPE/bin/CAPE-compare.jar CAPE-compare] |
| - | |||
| - | == | + | ==AnnotationLibrary Java Library== |
| - | + | CAPE makes use of the org.gersteinlab.annotation package, a series of classes and data structures written in Java. This library is already included in the JAR files for the above programs, but is also made available for the developer community as a separate compressed JAR file. | |
| - | [ | + | [http://archive.gersteinlab.org/proj/CAPE/lib/AnnotationLibrary.jar AnnotationLibrary] |
| - | == | + | ==Documentation== |
| - | + | ===Users Guide=== | |
| + | [https://docs.google.com/document/d/1k8RMymsbl2DikRHkOwj5tNnSA6y_9UReYjLWCFD4gRo/edit CAPE Users Guide (Google Doc)] | ||
| - | [http://archive.gersteinlab.org/proj/ | + | [http://archive.gersteinlab.org/proj/CAPE/docs/misc/CAPE_Users_Guide.pdf CAPE Users Guide (PDF)] |
| - | + | ===Use Cases=== | |
| + | The Use Cases document shows several sample workflows for CAPE. Example runs as well as links to sample data and output files are included in the document. If your browser is having trouble opening the pdf file, please right-click the link, select "Save Link As...", and view the saved file. | ||
| + | [http://archive.gersteinlab.org/proj/CAPE/usecases/CAPE_Use_Cases.pdf CAPE Use Cases] | ||
| - | == | + | ===Javadocs=== |
| - | + | [http://archive.gersteinlab.org/proj/CAPE/docs/javadoc/AnnotationLibrary/ AnnotationLibrary] | |
| - | [http://archive.gersteinlab.org/proj/ | + | [http://archive.gersteinlab.org/proj/CAPE/docs/javadoc/CAPE-analyze/ CAPE-analyze] |
| - | [http://archive.gersteinlab.org/proj/ | + | [http://archive.gersteinlab.org/proj/CAPE/docs/javadoc/CAPE-compare/ CAPE-compare] |
| - | + | ===UML=== | |
| + | [[CAPE Activity Diagrams|Activity Diagrams]] | ||
| - | + | [[CAPE Class Diagrams|Class Diagrams]] | |
| - | |||
| - | + | ==Source Code== | |
| + | CAPE is open source software. All source code is distributed as compressed JAR files. AnnotationLibrary's source code can be obtained by decompressing the AnnotationLibrary.jar file downloaded above. | ||
| - | + | [http://archive.gersteinlab.org/proj/CAPE/src/CAPEanalyze-src.jar CAPE-analyze] | |
| - | + | [http://archive.gersteinlab.org/proj/CAPE/src/CAPEcompare-src.jar CAPE-compare] | |
| - | |||
| - | + | ==Acknowledgement of External Libraries== | |
| - | + | CAPE-analyze makes use of the following external, publicly-available libraries: Google Guava, Apache Commons Math, Apache Commons CLI, and the Broad Institute’s IGV BigFile. CAPE-compare utilizes the Apache Commons CLI external library as well as the VennDiagram R package. The Java libraries are included as part of the respective executable jar file in their original, unaltered forms. VennDiagram can be downloaded from the link below or installed directly from R. | |
| + | |||
| + | For more information on each library, please see the following external links: | ||
[http://commons.apache.org/cli/ Apache Commons CLI] | [http://commons.apache.org/cli/ Apache Commons CLI] | ||
| + | |||
| + | [http://commons.apache.org/math/ Apache Commons Math] | ||
| + | |||
| + | [http://http://code.google.com/p/bigwig/ Broad IGV BigFile] | ||
[http://code.google.com/p/guava-libraries/ Google Guava] | [http://code.google.com/p/guava-libraries/ Google Guava] | ||
| - | [http:// | + | [http://cran.r-project.org/web/packages/VennDiagram/index.html VennDiagram] |
Latest revision as of 16:58, 3 July 2012
Contents |
Coupled Analysis of Polymerase and Expression (CAPE)
CAPE Is designed with two primary goals in mind. The first is to associate transcription factor binding site data from next-generation sequencing experiments such as ChIP-Seq with a set of genomic features such as transcription start sites, transcription end sites, etc. The second aim is to classify transcripts in a genome based on levels of transcription factor binding at the promoter vs the expression level of the transcript. CAPE is designed to work with many of the formats employed by large consortia such as NHGRI’s ENCODE and modENCODE consortia.
CAPE is written in Java and requires Java version 1.6 or higher. The Java runtime environment (JRE) must be installed. If the JRE is not installed (i.e. typing “java –version” at the command line does not produce a version number or the version number is < 1.6), an updated version of the Java Runtime Environment can be downloaded from the Java website.
Get the Program
CAPE programs are distributed as executable JAR files. Please see the Users Guide for more information.
AnnotationLibrary Java Library
CAPE makes use of the org.gersteinlab.annotation package, a series of classes and data structures written in Java. This library is already included in the JAR files for the above programs, but is also made available for the developer community as a separate compressed JAR file.
Documentation
Users Guide
Use Cases
The Use Cases document shows several sample workflows for CAPE. Example runs as well as links to sample data and output files are included in the document. If your browser is having trouble opening the pdf file, please right-click the link, select "Save Link As...", and view the saved file.
Javadocs
UML
Source Code
CAPE is open source software. All source code is distributed as compressed JAR files. AnnotationLibrary's source code can be obtained by decompressing the AnnotationLibrary.jar file downloaded above.
Acknowledgement of External Libraries
CAPE-analyze makes use of the following external, publicly-available libraries: Google Guava, Apache Commons Math, Apache Commons CLI, and the Broad Institute’s IGV BigFile. CAPE-compare utilizes the Apache Commons CLI external library as well as the VennDiagram R package. The Java libraries are included as part of the respective executable jar file in their original, unaltered forms. VennDiagram can be downloaded from the link below or installed directly from R.
For more information on each library, please see the following external links:
