Usage


This page will teach you how to:

Run slncky !


Usage: ./slncky.v1.0 bedfile assembly out_prefix

Examples

barebones:
./slncky.v1.0 transcripts.bed mm9 out

don't filter, just search for orthologs:
./slncky.v1.0 -2 transcripts.bed mm9 out.

create an evolutionary browser to view lncRNA orthologs:
./slncky.v1.0 -w transcripts.bed mm9 out

by default, slncky uses the annotations.config file in the same directory as itself, but you can set this path if you want:
./slncky.v1.0 -c ./annotations.config transcripts.bed mm9 out

if bedtools is not in your path:
./slncky.v1.0 --bedtools_path /unix/home/jjenny/bedtools-2.17.0/bin transcripts.bed mm9 out


Customize slncky

General Options
-c / --configSpecify path of annotations.config file. (Default:annotations.config assumed to be in same directory as ./slncky executable.)
-1 / --no_orth_searchOnly filter; don't search for orthologs.
-2 / --no_filterDon't filter; only search for orthologs.
-o / --overwriteForce overwrite of trancsripts.lncs.bed.
-n / --threadsNumber of threads to use for aligning transcripts. (Default: 5)
-w / --webCreate browser to visualize aligned lncRNAs.
--bedtoolsPath to bedtools executables. (Default: bedtools assumed to be in user's PATH)
--liftoverPath to liftover executable. (Default: bedtools assumed to be in user's PATH)
--lastzPath to lastz executable. (Default: bedtools assumed to be in user's PATH)
Filter Options
--min_overlapMinimum overlap for filtering transcripts overlapping CODING or MAPPED_CODING gene. (Default: 0.00)
--min_clusterMinimum size of duplication cluster for filtering paralogous transcripts. (Default: 2)
--min_codingMinimum identity for filtering transcripts that align to syntenic CODING gene. (Default: slncky learns threshold from input data.)
--no_collapseDo not collapse overlapping transcripts into single canonical gene.
--no_overlapDo not remove transcripts that overlap CODING or MAPPED_CODING gene.
--no_selfDo not remove transcripts sharing sequence similarity with each other.
--no_dupDo not remove transcripts that share sequence similarity with DUP genes.
--no_codingDo not remove transcripts that align to syntenic CODING genes.
Orthology Search Options
--min_noncodingMinimum overlap for reporting transcripts that align to syntenic NONCODING gene. (Default: slncky learns threshold by aligning to shuffled intergenic regions)
--no_bgDo not align to shuffled background; report all alignments. Setting this option will greatly reduce slncky runtime.
--no_orfDo not check for conserved ORFs in aligned noncoding transcripts.
Advanced orthology search options
--minMatchminMatch parameter to pass to liftOver. Decreasing this parameter will increase sensitivity of orthology search. (Default: 0.1)
--padNumber of basepairs up- and downstream of lncRNA loci to include in orthology search. Increasing this parameter will increase sensitivity of orthology search. (Default: 50,000)
--gap_openGap open penalty to pass to lastz. Decreasing this parameter will increase sensitivity of orthology search. (Default: 1.0)
--gap_extendGap extend penalty to pass to lastz. Decreasing this parameter will increase sensitivity of orthology search. (Default: 40)

Output


out.lncs.bed
Bed12 file of high-confidence long, non-coding RNAs

out.lncs.info.txt
A table of final lncRNA transcripts, names, category, based on supplied annotations.

out.filtered_info.txt / out.cluster_info.txt
filter_info contains a list of every filtered out transcripts with the reason for filtering. cluster_info contains names of transcripts found in duplication clusters

out.canonical_to_lncs.txt
A table of the canonical transcripts chosen from groups over overlapping transcripts.

out.orthologs.txt / out.orthologs.top.txt
A list of every ortholog pair, with additional information about the alignment. The out.orthologs.top.txt file contains only the best alignment (based on exonic identity) for each lncRNA.

out.orfs.txt
A list of alignments which contain ORFs longer than 30bp, along with additional information about the ORF alignment.

out_browser/
If the --web flag was set, slncky will create an evolutionary browser that is viewable from out_browser/browse.html