Code Monkey home page Code Monkey logo

pophelper's Introduction

pophelper 2.2.5.1

pophelper is an R package and web app to analyse and visualise population structure. pophelper curently supports output run files generated from population analysis programs such as STRUCTURE, TESS, TESS3, BAPS and numeric delimited formats such as ADMIXTURE or fastSTRUCTURE. The pophelper package can be used to read run files to R, tabulate runs, summarise runs, estimate K using the Evanno method, align clusters within K using CLUMPP, export files for DISTRUCT and generate barplot figures.

For a detailed demonstration and walkthrough, refer the online vignette. For information about changes in the latest version, visit this GitHub page.

Installation

You need to have R (> 3.3.0) statistical package installed on your system. R is open-source and freely available to download for Windows, Mac and other OS. Then, install the dependency packages. Then, you can install pophelper from github using the devtools package.

# install dependencies and devtools
install.packages(c("Cairo","ggplot2","gridExtra","gtable","tidyr","devtools"),dependencies=T)

# install pophelper package from GitHub
devtools::install_github('royfrancis/pophelper')

# load library for use
library(pophelper)

Note that pophelper 1.2.0 and later includes binary executables for CLUMPP and DISTRUCT. This is experimental and may not work on all OS and versions.

pophelper has been tested on the following systems:

  • Windows 10 64bit, R 3.4.3
  • Windows 10 64bit, R 3.3.3
  • Windows 7 64bit, R 3.4.0 (DISTRUCT is unstable)
  • Scientific Linux 6.8 (Carbon) 64bit, R 3.4.0

Web App

An online interactive version of pophelper is available at pophelper.com. The web app is quite outdated and limited in terms of functionality and flexibility. The web app must not be used for major work or large datasets. The web app is also limited in computational power and working hours. The web app will be automatically restricted after 100 hours of use per month. If anyone has ideas for funding pophelper web server, please get in touch.

Features

  • Read q-matrices from STRUCTURE, TESS 2.3, TESS 3, BAPS, fastSTRUCTURE, ADMIXTURE runs.
  • Tabulate/summarise reads.
  • Compute Evanno method to estimate K for STRUCTURE runs.
  • Aligned clusters for single K using CLUMPP.
  • Single line and multiline barplots with labelling, sorting and subsetting.
  • Export files for use with DISTRUCT.

Sample figures

Workflow
Fig: Workflow for all filetypes.

evanno-method
Fig: Plots from Evanno method.

plotq
Fig: Singleline barplots from q-matrices with individual and group labelling.

plotq-multiline
Fig: Multiline barplots from q-matrices with individual and group labelling.

For detailed demonstration and description, refer the vignette.

Disclaimer

The pophelper R package is offered free and without warranty of any kind, either expressed or implied. I will not be held liable to you for any damage arising out of the use, modification or inability to use this program. pophelper R package can be used, redistributed and/or modified freely for non-commercial purposes subject to the original source being properly cited. Licensed under GPL-3. Please make sure you verify all your results.

Contact

If you have an comments, suggestions, corrections or ideas on ways to improve or extend this package, feel free to contact me. Submit a report on the Github issues page.

2018 Roy M Francis

pophelper's People

Contributors

royfrancis avatar

Watchers

James Cloos avatar Wtong 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.