Skip to main content

ratecounter - Nexus file rate counter for language phylogenies

Project description

# RateCounter

[![Build Status](https://travis-ci.org/SimonGreenhill/RateCounter.svg?branch=master)](https://travis-ci.org/SimonGreenhill/RateCounter)
[![Coverage Status](https://coveralls.io/repos/github/SimonGreenhill/RateCounter/badge.svg?branch=master)](https://coveralls.io/github/SimonGreenhill/RateCounter?branch=master)
[![DOI](https://zenodo.org/badge/DOI/10.3389/fpsyg.2018.00576.svg)](https://doi.org/10.3389/fpsyg.2018.00576)


*RateCounter* is a python library and program for calculating the number of rate differences between taxa given a nexus file.

It is based on the method in:

```
Greenhill SJ, Hua X, Welsh CF, Schneemann H & Bromham L. 2018. [Population Size and the Rate of Language Evolution: A Test across Indo-European, Austronesian and Bantu Languages](https://www.frontiersin.org/articles/10.3389/fpsyg.2018.00576/abstract). Frontiers in Psychology doi: 10.3389/fpsyg.2018.00576
```

Please cite this paper if you find this software helpful.

**Installation:**

```shell
pip install RateCounter
```

**Usage:**

As a standalone program:

```shell
> ratecounter --help

usage: ratecounter [-h] [-v] nexus taxon1 taxon2

Calculate rates from the nexus for the two taxa

positional arguments:
nexus nexusfile
taxon1 Taxon 1
taxon2 Taxon 2

optional arguments:
-h, --help show this help message and exit
-v, --verbose increases verbosity


> ratecounter test.nex Taxon1 Taxon2
GAIN A 1
GAIN B 1
LOSS A 1
LOSS B 1
TOTAL A 2
TOTAL B 2
ABSENCE 1
RETENTION 1
SHARED GAIN 1
SHARED LOSS 1
UNCOUNTABLE 19
TOTAL 27
```

As a python library

```python
from ratecounter.main import RateCounter

rc = RateCounter(nexusfile=args.nexusfile)
scores = rc.get_scores(Taxon1, Taxon2)
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

RateCounter-1.1.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

RateCounter-1.1-py2.py3-none-any.whl (10.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file RateCounter-1.1.tar.gz.

File metadata

  • Download URL: RateCounter-1.1.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for RateCounter-1.1.tar.gz
Algorithm Hash digest
SHA256 4a1aaff2b4b05c8715f7b50dbc7e2b8c4cb4f1c0b3a330b753f4a30367017d3a
MD5 454713259f83ea014053e8dcff1f1304
BLAKE2b-256 98c4cef751b8325b2b758c60fab2dbd093cb3991751517c0ea6d3ceca31fb3d6

See more details on using hashes here.

File details

Details for the file RateCounter-1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for RateCounter-1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1688f8d25495ed20bc3197f75040aa54b682da5e801935c2683120022d098a64
MD5 3f357d31593fe28c26f473b7863cbad0
BLAKE2b-256 0d1c72d228cdfcab9b313ca39e7e444c5d7f550578de8a7b6c3b0d17ed78d7e3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page