Files
snpr/README.md
Bastian Greshake Tzovaras f0f494b940 Replace dead badges (#551)
2023-01-04 18:26:06 +01:00

34 lines
2.3 KiB
Markdown

# openSNP
[![Build Status](https://github.com/openSNP/snpr/actions/workflows/build.yml/badge.svg)](https://github.com/openSNP/snpr/actions/workflows/build.yml) [![Join the chat at https://gitter.im/openSNP/snpr](https://badges.gitter.im/openSNP/snpr.svg)](https://gitter.im/openSNP/snpr?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Hello! [openSNP.org](https://opensnp.org) is a repository to which users can upload their SNP-sets (and exome-VCFs) from
23andme, deCODEme, FamilyTreeDNA, AncestryDNA and IYG-format (for participants
of EBI genotyping). On upload, SNPs are annotated using the PLoS and
Mendeley-APIs to show users the newest scientific research results on their
SNPs. Each SNP is also linked to the relevant page on SNPedia. SNPs are ranked
according to how many results could be gathered for SNPedia, PLoS and Mendeley
(in that order). Users can send each other private messages as well as comment
on SNPs and Phenotypes.
## Installing openSNP
Please see [INSTALL.md](https://github.com/openSNP/snpr/blob/master/INSTALL.md) for more detailed instructions on how to run and setup openSNP.
## Contributing to openSNP
Thanks for your interest in helping us out! You are awesome! Please see [CONTRIBUTING.md](https://github.com/openSNP/snpr/blob/master/CONTRIBUTING.md) for more detailed instructions on how to contribute. We also [have a ROADMAP.md](https://github.com/openSNP/snpr/blob/master/ROADMAP.md), containing our idea of where the project should head.
The project has a [Code of Conduct](https://github.com/openSNP/snpr/blob/master/CODE_OF_CONDUCT.md) in order to make this a safe and inclusive space for everyone.
Thanks go to everyone who has contributed so far. May you be celebrated, [inside our humans.txt](https://github.com/openSNP/snpr/blob/master/public/humans.txt) and outside of it!
## Getting in contact
You can always open an issue for specific problems, or send a mail to snpr-development@googlegroups.com if you want to discuss something or if you have any questions or need help with something. There's also info@opensnp.org if something broke on the site itself.
We're also available on Twitter:
@[gedankenstuecke](https://twitter.com/gedankenstuecke)
@[helgerausch](https://twitter.com/helgerausch)
@[philippbayer](https://twitter.com/philippbayer)
[You can also join us on Gitter](https://gitter.im/openSNP/snpr).