Git Product home page Git Product logo

plmdca's Introduction

PlmDCA

Build Status Build status codecov

Pseudo-likelihood maximization in Julia. A complete description of the algorithm can be found at http://plmdca.csc.kth.se/. If you use this algorithm you should cite:

  1. M. Ekeberg, C. Lovkvist, Y. Lan, M. Weigt, E. Aurell, Improved contact prediction in proteins: Using pseudolikelihoods to infer Potts models, Phys. Rev. E 87, 012707 (2013)

  2. M. Ekeberg, T. Hartonen, E. Aurell, Fast pseudolikelihood maximization for direct-coupling analysis of protein structure from many homologous amino-acid sequences, arXiv:1401.4832 (supplementary material)

The present software is a Julia implementation of above mentioned papers, with no reference to the original MATLAB software implementation.

The code now requires at least Julia version 1.5 or later.

Install

To install just use the package manager and do a

(v1.?) pkg> add https://github.com/pagnani/PlmDCA

Overview

The code internally uses NLopt which provides a Julia interfaces to the free/open-source NLopt library.

Usage

To load the code just type

julia> using PlmDCA

The functions in this package are written to maximize performance. Most computationally-heavy functions can use multiple threads (start julia with the -t option or set the JULIA_NUM_THREADS environment variable). For more information on how set correctly the number of threads, please refer to the online Julia Documentation on Multi-Threading.

The program (only in its symmetric version plmdca_sym) can be run on multiple cores previous addprocs(nprocs) where nprocs should be some integer number np lower or equal to your (physical) number of cores.

The software provides two main functions plmdca(filename::String, ...) and plmdca_sym(filename::String,...) (resp. the asymmetric and symmetric coupling version of the algorithm). Empirically it turns out that the asymmetric version is faster and more accurate. This function take as input the name of a (possibly zipped) multiple sequence.

We also provide another function mutualinfo(filename::String,...) to compute the mutual information score.

There are a number of possible algorithmic strategies for the optimization problem. As long as local gradient-based optimization is concerned, this is a list of :symbols (associated to the different methods):

:LD_MMA, :LD_SLSQP, :LD_LBFGS, :LD_TNEWTON_PRECOND
:LD_TNEWTON_PRECOND_RESTART, :LD_TNEWTON, :LD_VAR2, :LD_VAR1

After some experiments we found that the best compromise between accuracy and speed is achieved by the Low Storage BFGS method :LD_LBFGS, which is the default method in the code. The other methods can be set changing the default optional argument (e.g. method=:LD_SLSQP).

There are more optional arguments that can be set (to be documented...).

Output

The functions output a type PlmOut (say X) with 4 fields:

  • X.Jtensor: the coupling matrix J[ri,rj,i,j] a symmetrized q x q x N x N array, where N is the number of residues in the multiple sequence alignment, and q is the alphabet "size" (typically 21 for proteins).
  • X.htensor: the external field h[r_i,i] q x N array.
  • X.pslike: the pseudolikelihood
  • X.score: a vector of Tuple{Int,Int,Float64} containing the candidate contacts in descending score order (residue1, residue2 , score12).

Requirements

  • The minimal julia version for using this code is 1.3 (package version <= v0.2.0)

  • From package versions 0.3.0 on the minimal julia requirement is 1.5

Todos

A lot!

plmdca's People

Contributors

pagnani avatar guido-u avatar christophfeinauer avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.