GithubHelp home page GithubHelp logo

stephenturner / quickped Goto Github PK

View Code? Open in Web Editor NEW

This project forked from magnusdv/quickped

0.0 1.0 0.0 273 KB

An online pedigree creator for research applications. Build pedigrees interactively and store as images or text files in ped format.

Home Page: https://magnusdv.shinyapps.io/quickped

R 100.00%

quickped's Introduction

QuickPed

What is QuickPed?

QuickPed is an interactive web application for drawing and analysing pedigrees. A created pedigree may be saved as an image or as a text file in ped format (see below). You may also obtain various information about the pedigree, including relatedness coefficients and verbal descriptions of relationships.

QuickPed is powered by the ped suite and kinship2 for pedigree plotting. The web app was built with Shiny.

Getting started

Creating pedigrees with QuickPed is very intuitive: Select a suitable start pedigree and modify it as needed. You may also load an existing ped file (see below). Modifications are done by clicking on one or several individuals and then applying appropriate buttons, for instance to add children, siblings or parents. At any time you may change attributes like sex, affection status, twin status and ID labels.

Tips and tricks

  • Selecting individuals. Select/deselect pedigree members by clicking on them. Selected individuals are shown in red colour. Pro tip: To deselect everyone, click the “Selection” button under the “Remove” heading.
  • Labels: Automatic labelling of the pedigree members are available in two different formats. The button marked 1,2,.. applies numeric labels to all individuals, in the order of their appearance in the pedigree plot. Alternatively, the I-1, I-2,.. button numbers the members generation-wise, using roman numerals to indicate the generation number.
  • Unknown sex. If you double click on a pedigree member, its symbol will change into a diamond representing unknown sex. Double click again to revert. Note: Only pedigree leaves (members without children) may have unknown sex.
  • Plot settings. If the pedigree gets too large, increase the plot region using the control panel on the far right. Here you may also adjust the margins, the size of pedigree symbols and text labels.

Built-in pedigrees

In the left-most panel of QuickPed the user may choose among a selection of standard pedigrees, including trios, full/half siblings, avuncular and cousin pedigrees of different kinds. Also included are several interesting (albeit less common) pedigree structures like double cousins and quad half first cousins. Finally, the following historic pedigrees are available:

Relationship information

The buttons Coeffs and Describe can be used to analyse the relatedness between selected individuals in the current pedigree.

  • Coeffs: This prints a variety of pedigree coefficients.

    • The inbreeding coefficient of each individual (this works for any number of selected members).
    • The kinship coefficient φ.
    • The IBD coefficients κ = (κ0,κ1,κ2), defined as the probabilities of sharing 0, 1, and 2 alleles identical by descent (IBD). These are well-defined only if both individuals are non-inbred.
    • The 9 condensed identity coefficients of Jacquard, Δ = (Δ1,...,Δ9).

    More information about these coefficients can be found in the documentation of the ribd package, which is used in the calculations.

  • Describe: This prints a verbal description of the relationship, generated by verbalisr.

Ped files

A useful feature of QuickPed is to produce text files describing pedigrees in so-called ped format. Such files are often required by software for pedigree analysis.

For a simple illustration, consider this pedigree:

A text file describing this pedigree may contain the following.

 id fid mid sex aff
  1   0   0   1   1
  2   0   0   2   1
  3   1   2   2   2

The columns are:

  • id: Individual ID
  • fid: Father’s ID (or 0 if not included in the pedigree)
  • mid: Mother’s ID (or 0 if not inlcuded in the pedigree)
  • sex: Sex (1 = male; 2 = female; 0 = unknown)
  • aff: Affection status (1 = unaffected; 2 = affected; 0 = unknown)

It should be noted that the ped format is not completely standardised, and different software may use slightly different versions. For example, a first column with Family ID is sometimes required. Also, the aff column may not be needed in non-medical applications. These and other details may be specified when using QuickPed.

Some pedigree information may be shown on the plot, but is not stored in the ped file. In the current version of QuickPed, this includes twin relationships, and also deceased status.

quickped's People

Contributors

magnusdv avatar

Watchers

 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.