Skip to content

Commit

Permalink
Add badges, fix links (#101)
Browse files Browse the repository at this point in the history
* fix heading
* add badges
* minor formatting cleanups
* fix URLs to papers so they work outside generated docs
* move all replace text to bottom
* full instructions -> detailed instructions
  • Loading branch information
alexlancaster authored Jul 25, 2023
1 parent 8e216d5 commit 40ed48d
Showing 1 changed file with 46 additions and 16 deletions.
62 changes: 46 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
Python for Population Genomics (PyPop)
======================================
|Build status| |Website pypop.org| |GitHub license| |Citations|


PyPop: Python for Population Genomics
=====================================

PyPop is a framework for processing genotype and allele data and
running population genetic analyses, including conformity to
Hardy-Weinberg expectations; tests for balancing or directional
selection; estimates of haplotype frequencies and measures and tests
of significance for linkage disequilibrium (LD). . See the `PyPop
of significance for linkage disequilibrium (LD). See the `PyPop
User Guide <http://pypop.org/docs>`__ for a more detailed description.

.. |pkgname| replace:: ``pypop-genomics``

.. _guide-include-pypop-cite-start:

**How to cite PyPop**
Expand All @@ -20,7 +21,7 @@ When citing PyPop, please cite the (2007) paper from *Tissue Antigens*:
G. Thomson (2007) "PyPop update - a software pipeline for
large-scale multilocus population genomics" *Tissue Antigens* 69 (s1), 192-197.
[`journal page <http://dx.doi.org/10.1111/j.1399-0039.2006.00769.x>`__,
`preprint PDF (112 kB) <tissue-antigens-lancaster-2007.pdf>`__].
`preprint PDF (112 kB) <http://pypop.org/tissue-antigens-lancaster-2007.pdf>`__].

In addition, you can also cite our 2003 Pacific Symposium on Biocomputing paper:

Expand All @@ -30,7 +31,7 @@ In addition, you can also cite our 2003 Pacific Symposium on Biocomputing paper:
*Pacific Symposium on Biocomputing* vol. 8:514-525 (edited by R B
Altman. et al., World Scientific, Singapore, 2003) [`PubMed
Central <https://www.ncbi.nlm.nih.gov/pmc/articles/PMC3891851/>`__,
`PDF (344 kB) <psb-pypop.pdf>`__].
`PDF (344 kB) <http://pypop.org/psb-pypop.pdf>`__].

.. _guide-include-pypop-cite-end:

Expand All @@ -44,8 +45,8 @@ In addition, you can also cite our 2003 Pacific Symposium on Biocomputing paper:
may change and is not yet the final package name until the package
is released to PyPI.

Quickstart
==========
Quickstart Guide
================

**Installing** |pkgname|

Expand Down Expand Up @@ -79,7 +80,7 @@ environment variable.
pip uninstall pypop-genomics
**For more, including handling common installation issues, see the** `full installation instructions`_ **.**
**For more, including handling common installation issues, see the** `detailed installation instructions`_ **.**

Once you have installed |pkgname|, you can move on to try some
`example runs <Examples_>`__.
Expand Down Expand Up @@ -145,8 +146,8 @@ plain text version:
USAFEL-UchiTelle-small-out.txt


Full installation instructions
==============================
Detailed installation instructions
==================================

There are three main steps:

Expand Down Expand Up @@ -357,10 +358,12 @@ The development of the code for PyPop is via our GitHub project:

For a detailed description on bug reporting as well as how to
contribute to PyPop, please consult our `CONTRIBUTING.rst
<CONTRIBUTING.rst#reporting-and-requesting>`_ guide. We also have
additional notes and background relevant for developers in
`DEV_NOTES.md <DEV_NOTES.md>`__. Source for the website and the
documentation is located in the `website <website>`__ subdirectory.
<https://github.com/alexlancaster/pypop/blob/main/CONTRIBUTING.rst>`_
guide. We also have additional notes and background relevant for
developers in `DEV_NOTES.md
<https://github.com/alexlancaster/pypop/blob/main/DEV_NOTES.md>`__. Source
for the website and the documentation is located in the `website
<https://github.com/alexlancaster/pypop/blob/main/website>`__ subdirectory.

Copyright and License
=====================
Expand All @@ -371,3 +374,30 @@ California (Regents)
Copyright (C) 2007-2023 PyPop team.

PyPop is distributed under the terms of GPLv2


.. |pkgname| replace:: ``pypop-genomics``

.. |GitHub release| image:: https://img.shields.io/github/release/alexlancaster/pypop.svg
:target: https://github.com/alexlancaster/pypop/releases/

.. |Build status| image:: https://github.com/alexlancaster/pypop/actions/workflows/build_wheels.yml/badge.svg?branch=main
:target: https://github.com/alexlancaster/pypop/actions/workflows/build_wheels.yml

.. |GitHub license| image:: https://img.shields.io/github/license/alexlancaster/pypop.svg
:target: https://github.com/alexlancaster/pypop/blob/master/LICENSE

.. |GitHub issues| image:: https://img.shields.io/github/issues/alexlancaster/pypop.svg
:target: https://github.com/alexlancaster/pypop/issues

.. |Citations| image:: https://api.juleskreuer.eu/citation-badge.php?doi=10.1111/j.1399-0039.2006.00769.x
:target: https://juleskreuer.eu/projekte/citation-badge/

.. |GitHub version| image:: https://badge.fury.io/gh/alexlancaster%2Fpypop.svg
:target: https://github.com/alexlancaster/pypop/

.. |GitHub tag| image:: https://img.shields.io/github/tag/alexlancaster/pypop.svg
:target: https://github.com/alexlancaster/pypop/tags/

.. |Website pypop.org| image:: https://img.shields.io/website-up-down-green-red/http/pypop.org.svg
:target: http://pypop.org/

0 comments on commit 40ed48d

Please sign in to comment.