README 2.26 KB
Newer Older
Michael Menzel's avatar
Michael Menzel committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
# Enhort: Genomic Position Profiling

The rise of high-throughput methods in genomic research greatly expanded our 
knowledge about the functionality of the genome. At the same time, the amount 
of available genomic position data increased massively, e.g., through genome-wide 
profiling of protein binding, virus integration or DNA methylation. 
However, there is no specialized software to investigate integration site profiles 
of virus integration or transcription factor binding sites by correlating the sites 
with the diversity of available genomic annotations.

Here we present Enhort, a user-friendly software tool for relating large sets of 
genomic positions to a variety of annotations. It functions as a statistics based 
genome browser, not focused on a single locus but analyzing many genomic positions 
simultaneously. Enhort provides comprehensive yet easy-to-use methods for statistical 
analysis, visualization, and the adjustment of background models according to 
experimental conditions and scientific questions.



# Availability

Enhort is publicly available online at www.enhort.mni.thm.de and published under GNU General Public License.


Michael Menzel's avatar
Michael Menzel committed
25
# Use pre-build
Michael Menzel's avatar
Michael Menzel committed
26 27 28

A seperate SETUPINSTR.md file is available containing instructions to run Enhort on your own infrastructure.

Michael Menzel's avatar
Michael Menzel committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
# Build

A JDK with Java 8 or higher is needed, as well as Maven.

Build steps:
- Download the sources from https://git.thm.de/mmnz21/Enhort
- cd into the enhortlib folder
- run 'mvn package' to build the library
- run the following to add the library to the local .m2 folder and repository:
    mvn install:install-file -Dfile=Enhortlib-1.01.jar -DpomFile=pom.xml
- cd back and into the /backend
- run 'mvn package -Dmaven.test.skip=true'
- Tests are skipped because several test-files are needed to run them 
- cd back and into the /frontend directory
- run 'mvn package' 
- go up one directory
- rename both jars with: 
    mv backend/target/Enhort-1.01-jar-with-dependencies.jar enhort.jar
    mv frontend/target/Enhort-1.01-jar frontend.jar
- continue with the set up as described in the SETUPINSTR.md file 

Michael Menzel's avatar
Michael Menzel committed
50 51 52 53

# VM

There is a VirtualBox image with Enhort set up for reference and to test with your own data:
Michael Menzel's avatar
Michael Menzel committed
54 55 56 57 58 59 60

https://zenodo.org/record/2597397
https://doi.org/10.5281/zenodo.2597397

DOI: 10.5281/zenodo.2597397


Michael Menzel's avatar
Michael Menzel committed
61