The MutationOrder package

[ Tags: bioinformatics, gpl, library, program ] [ Propose Tags ]

Determine the most likely order in which single nucleotide mutations happened between two RNA sequences.

Developed to analyse the HAR 1 region, but agnostic to the actual sequences and can be used to analyze any RNA sequence that fits the algorithmic constraints.

As long as the two input RNAs are small enough enough (couple hundred nucleotides) and the number of mutations is small enough (around 20-26, since the algorithm is exponential in this number) the algorithm should work for similar problems without changes.

We currently only consider point mutations, not in-dels.


[Skip to Readme]

Properties

Versions 0.0.0.1, 0.0.0.2, 0.0.1.0
Change log changelog.md
Dependencies ADPfusion (==0.5.2.*), ADPfusionSet (==0.0.0.*), aeson (>=1.1), attoparsec (>=0.13), base (>=4.7 && <5.0), bimaps (==0.1.0.*), BiobaseXNA (==0.9.3.*), bytestring, bytestring-trie (>=0.2), cereal (>=0.5), cereal-vector (>=0.2), cmdargs (>=0.10), containers, deepseq (>=1.4), directory, DPutils (==0.0.1.*), errors (>=2.0), file-embed (>=0.0.8), filemanip (>=0.3), filepath, FormalGrammars (==0.3.1.*), hashable (>=1.2), lens (>=4.0), log-domain (>=0.10), mtl, MutationOrder, OrderedBits (==0.0.1.*), parallel (>=3.2), PrimitiveArray (==0.8.0.*), PrimitiveArray-Pretty (==0.0.0.*), serialize-instances (>=0.1), ShortestPathProblems (==0.0.0.*), split (>=0.2), text (>=1.0), unordered-containers (>=0.2.7), vector (>=0.11), vector-strategies (>=0.4), ViennaRNA-bindings (==0.233.1.*), zlib (>=0.6) [details]
License GPL-3
Copyright Maria Beatriz Walter Costa, Christian Hoener zu Siederdissen, 2017
Author Maria Beatriz Walter Costa, Christian Hoener zu Siederdissen, 2017
Maintainer choener@bioinf.uni-leipzig.de
Category Bioinformatics
Home page https://github.com/choener/MutationOrder
Bug tracker https://github.com/choener/MutationOrder/issues
Source repository head: git clone git://github.com/choener/MutationOrder
this: git clone git://github.com/choener/MutationOrder/tree/0.0.1.0(tag 0.0.1.0)
Uploaded Tue Oct 24 21:28:42 UTC 2017 by ChristianHoener
Distributions NixOS:0.0.1.0
Executables MutationOrder
Downloads 215 total (67 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
Last success reported on 2017-10-24 [all 2 reports]
Hackage Matrix CI

Modules

  • BioInf
    • BioInf.MutationOrder
      • BioInf.MutationOrder.BackMutations
      • BioInf.MutationOrder.EdgeProb
      • BioInf.MutationOrder.MinDist
      • BioInf.MutationOrder.RNA
      • BioInf.MutationOrder.SequenceDB

Flags

NameDescriptionDefaultType
debug

Enable bounds checking and various other debug operations at the cost of a significant performance penalty.

DisabledManual
debugoutput

Enable debug output, which spams the screen full of index information

DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for MutationOrder-0.0.1.0

[back to package description]

Build Status

Determine the most likely order of mutations from one RNA sequence to another.

Walter Costa, Maria Beatriz and Hoener zu Siederdissen, Christian and Tulpan, Dan and Stadler, Peter F. and Nowick, Katja  
*Uncovering the Structural Evolution of the Human Accelerated Region 1*  
2017, submitted  
[preprint](http://www.bioinf.uni-leipzig.de/~choener/pdfs/wal-hoe-2017.pdf)  

General information

Given two RNA sequences, one ancestral, and one extant, we want to determine the most likely path of evolution under different measures of fitness.

This program produces the (i) maximum-likelihood path, (ii) all end probabilities, (iii) all start-end probabilities, (iv) all edge probabilities, and (v) the maximum expected accuracy path for these two RNA sequences.

In detail:
(i) gives the optimal path(s) for the fitness function
(ii) gives for each nucleotide polymorphism, how likely it is, that this mutation was introduced last
(iii) looks at all pairs of (first mutation, last mutation) and gives the probability that these two mutations are the begin and end of the chain of mutations
(iv) yields for all pairs of nodes (i -> j) the probability that this path occurs, over the whole ensemble of all possible paths
(v) produces the path of maximal weight using the probabilities produced in (iv)

Usage instructions

sequence generation

First, the sequence data base needs to be created. The following assumptions are being made:

  • chimp_118.fa is the origin sequence.
  • human_118.fa is the target sequence.
  • all known mutations are to be ordered.
  • One intermediate (or backmutation) is allowed. This will already lead to an expansion of the sequence space from ca. 250K sequences to 83.6M sequences! Use your local compute cluster or download our precalculated data.

The following command will prepare the working database and populate the seqs subdirectory.

mkdir workdb
mkdir workdb/seqs
mkdir workdb/rnafold
./MutationOrder gensequences -w workdb --ancestral chimp_118.fa -e human_118.fa -g 1 --sequencelimit 100000000 --alphabet=ACGT --seqsperfile=100000

example usage

We assume that you have two Fasta files, chimp_118.fa and human_118.fa but they can be named however is convenient. Each file has to contain exactly one sequence and both sequences have to be of the same length.

For testing with chimp and human, the provided chimp-human.json.gz database should be used, otherwise the initial foldings will be recalculated. All required files are available under 'Binaries' at the bottom of the page.

In case, you don't want or can't use the provided work database, run ./MutationOrder with --verbose

We then run

./MutationOrder --workdb chimp-human.json.gz --scoretype pairdistcen --onlypositive --outputprefix test chimp_118.fa human_118.fa

This will generate test.run, test-edge.eps, and test-meaorder.eps.

The test.run file provides extensive output of the optimal path, the first-last probabilities, the edge probabilities, and the mea output. This conforms to (i) -- (v) mentioned above.

The two eps files give a graphical representation of the edge probabilities, for the meaorder in order of the path of maximum expected accuracy.

The work database collects intermediate structures and their folding and is only created once. The initial run will, however, take some time. I.e. for 'HAR1' this requires 1-4 hours depending on the machine. Further runs complete much faster. In minutes for HAR1.

Command-line options

--help        provides short help
--verbose     will show folding steps during the initial run

-w
 --workdb=ITEM              the database where to store intermediate foldings
-t
--temperature=NUM           annealing temperature. Values close to 0 favor optimal paths. The default is 1.0
--fillweight=FILLWEIGHT     provides logarithmic and linear fill styles for probability plots. The full style always fills the box
--fillstyle=FILLSTYLE       normally, boxes are sized, but all in the same color. This changes the opacity of the color as well. Does not work well for eps files
--cooptcount=INT            how many co-optimals to count for (the count in the .run file is produced differently)
--cooptprint=INT            how many co-optimals to actually print
--outprefix=ITEM            how to prefix all output files
--scoretype=SCORETYPE       choose 'mfe', 'centroid', 'pairdistmfe', or 'pairdistcen' for the evaluation of each mutational step
--positivesquared           square positive energies to penalize bad moves
--onlypositive              minimize only over penalties, not energy gains
--equalstart                each possible mutation is selected with equal probability as the initial one
--posscaled=NUM,NUM         in =x,y will exponentiate all numbers >=x by the constant y. For value k>=x, we have k^y
--lkupfile=ITEM             developer option to feed the initial work database with known foldings (usable but very raw and undocumented. needs 5-line rnafold output)
--showmanual                will show this manual

The allowed score types are:

mfe

which optimizes based on the minimum free energy of each intermediate sequence centroid which instead looks at the energy of the centroid structure pairdistmfe which minimizes the base pair distance between following mutations using mfe structures pairdistcen which minimizes the base pair distance between following mutations using centroid structures

Installation

Pre-built binaries for Linux are avaiable under github releases

Follow this link to the bottom of the page for instructions to build from source.

Contact

Christian Hoener zu Siederdissen
Leipzig University, Leipzig, Germany
choener@bioinf.uni-leipzig.de
http://www.bioinf.uni-leipzig.de/~choener/