This repository has been archived by the owner. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
pdf version update
- Loading branch information
Showing
5 changed files
with
45 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,40 @@ | ||
**Welcome to the UROPA documentation!** | ||
|
||
Please visit the [UROPA-manual](http://uropa-manual.readthedocs.io/en/latest/) | ||
UROPA is a command line based tool, intended for genomic region annotation. Based on a configuration file, different target features can be prioritized with multiple integrated queries. | ||
These can be sensitive for feature type, distance, strand specificity, feature attributes (eg. protein_coding) or the anchor position relative to the feature. | ||
UROPA can incorporate reference annotation files (GTF) from different sources, like Gencode, Ensembl, or RefSeq, as well as custom reference files produced by the user. | ||
|
||
**Advantages of UROPA** | ||
|
||
* Simple usage: No programming | ||
* Utilization of all available GTF files as annotation database | ||
* Detect the most appropriate annotation with flexible keys that allow robustness and simple customization, such as | ||
* feature type | ||
* feature anchor | ||
* feature direction relative to peak location | ||
* filter for attribute values, e.g. "protein_coding" | ||
* strand specificity | ||
* Preparation of custom annotation files | ||
* One run with multiple sets of parameters by multiple queries | ||
* Graduated annotation due to priorization | ||
* Different easily-readable output tables (AllHits, FinalHits, BestperQuery_Hits). | ||
* Visual summary for annotation evaluation | ||
* Annotation with default values | ||
|
||
**How to cite** | ||
|
||
Please cite the paper describing UROPA when using it in your research: | ||
tba | ||
|
||
**Contribute** | ||
|
||
Source Code [here](https://github.molgen.mpg.de/loosolab/UROPA) | ||
Further details see [here](http://uropa.readthedocs.io/en/latest/install/) | ||
|
||
**Support** | ||
|
||
If you have any issue feel free to send an email to Maria Kondili (maria.kondili@mpi-bn.mpg.de) | ||
|
||
**Licence** | ||
|
||
The project is licensed under the MIT license |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters