Installation


This page will teach you how to:

Step 1: Download slncky and all dependencies


Download slncky from its github.

Note slncky was developed using Python v2.7 and will not work with Python v2.6 or Python v3. To check what version of python you have, type python --version into your terminal. Note slncky currently is not compatible with bedtools v2.25 or greater. An update is on its way.

slncky is depending on three easily downloadable softwares:
You must have all three software downloaded and available in your PATH. If you cannot add them to your path, you can specify the path by using the flags --bedtools_path, --liftover_path, and --lastz_path.


Step 2: Configure annotations


We need several annotation files in order to filter for lncRNAs and discover orthologs. For your convenience, you can download all the necessary annotations here:
Download the annotations.tar.gz file into the same directory as the ./slncky.v1.0 executable and un-tarball it (tar -xzvf annotations.tar.gz). By default, slncky will use these annotations and the annotations.config file in this directory. If you wish to run everything with default parameters, skip to the Usage page. If you want to use your own annotations or adjust the annotation parameters, read below.

What are the annotations slncky uses and why?
If you would like to use your own annotation files, specify the full path in the annotations.config file. Precede list of annotations for a given species by species specifier (e.g. >mm9). Prepending a '#' to any line comments out that annotation. For example, we have commented out annotations for UCSC's "near coding" genes, but if you wish to have a stricter lncRNA filter, you may un-comment out this line.