Skip to content

Commit

Permalink
Updates docs and bumps version
Browse files Browse the repository at this point in the history
  • Loading branch information
StuntsPT committed Mar 14, 2018
1 parent 540c114 commit 8d967eb
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# *pyRona* changelog

## Changes made in version 0.3.2

* Corrects a bug in when using outliers
* Better PEP8 conformance
* Implements automated test coverage measurements

---

## Changes made in version 0.3.1

* Corrects a bug in the installation of the R script `LFMM_workflow.R`
Expand Down
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This section describes how to use *pyRona*. All options as of version 0.2.0 are
- *pyRona* requires some parameters to be set in order to perform the analysis. These are:
- Common options to both *Baypass* and *LFMM*:
- `-covars`: [**optional**] Number of covars to calculate the RONA for (default: 3)
- `-outliers`: [**optional**] Number of outliers to remove - "0" skips outlier removal, "1" removes a maximum of 1 outlier (if there is one), "2" removes any number of markers considered outliers (default: 2)
- `-remove-outliers`: [**optional**] Pass this option if you want to *pyRona* to calculate the regression trend-line *after* removing any coordinates considered outliers
- `-immutables`: Covariates to skip from the environmental variables file. Useful to skip variables that are the same in te present covars and future covars file, such as latitude (default: 1 2 3)
- `-ronatype`: Defines the RONA is calculated. `absdiff` performs calculations as described in Rellstab et al. 2016 - using the absolute value of the differences, `diff` uses the differences without modulus, and `dist` accounts simply for the distance between the future condition and the trendline (default: `absdiff`)
- *Baypass* specific options:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class NotSupportedException(BaseException):


# Set some variables (PKGBUILD inspired)
VERSION = "0.3.1"
VERSION = "0.3.2"
URL = "https://github.com/StuntsPT/pyRona"


Expand Down

0 comments on commit 8d967eb

Please sign in to comment.