@farvater/open-pedigree
v1.0.108
Published
A free and open-source genetics pedigree tool powered by PhenoTips®
Downloads
125
Readme
A free and open-source pedigree tool powered by PhenoTips®
Open Pedigree is a robust browser-based genomic pedigree drawing solution using Prototype, Raphaël, and PhenoTips.
Features
✔ Robust support for complex families, intergenerational linkages, and consanguinity
✔ Shade nodes with disorders and/or candidate genes
✔ Quickly start with family templates
✔ Automatic consanguinity detection
✔ Import from PED, LINKAGE, GEDCOM (Cyrillic), BOADICEA, or GA4GH Pedigree (FHIR)
Getting started
Command line
Quickly get started with open pedigree on your computer:
git clone [email protected]:phenotips/open-pedigree.git
cd open-pedigree
npm install
npm start
Open a browser to http://localhost:9000/
Docker
You can also use the supplied Docker image to run the applicarion. To get started:
git clone [email protected]:phenotips/open-pedigree.git
cd open-pedigree
docker build . -t open-pedigree
docker run -p 9000:9000 -d open-pedigree
Contributing
Contributions welcome! Fork the repository and create a pull request to share your improvements with the community.
In order to ensure that the licensing is clear and stays open, you'll be asked to sign a CLA with your first pull request.
Support
This is free software! Create an issue in GitHub to ask others for help, or try fixing the issue yourself and then make a pull request to contribute it back to the core.
If you are interested in the Enterprise/commercial version, please contact PhenoTips.
License
Copyright (c) 2019-2022 Gene42 Inc. o/a PhenoTips
Open Pedigree is distributed under the LGPL-2.1 (GNU Lesser General Public License).
You can easily comply with this license by:
- including prominent notice of the use of Open Pedigree in your software
- retaining all copyright notices in the software
- ensuring that any and all changes you make to the software are published and open-sourced under the LGPL