Skip to content

Commit

Permalink
Prepare release v0.5.0 (#182)
Browse files Browse the repository at this point in the history
* bump version

* update license year

* use cannonical links in README

* use cannonical link

* replace url with cannonical form
  • Loading branch information
paulstaab authored Dec 28, 2016
1 parent 2a7ad60 commit 30f42c8
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 23 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@
*.so
.Rproj.user
vignettes/abc_cache
cran-comments.md
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: coala
Version: 0.4.1.9006
Version: 0.5.0
License: MIT + file LICENSE
Title: A Framework for Coalescent Simulation
Authors@R: c(
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
YEAR: 2015
YEAR: 2015-2016
COPYRIGHT HOLDER: Paul Staab
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
coala 0.5.0
===========

* Major interal refactoring on how simulators interface with coala (#174).
* Major internal refactoring on how simulators interface with coala (#174).
* Support for calculating an expanded version of MCMF (#173, #179). This
feature was contributed by Jorge E. Amaya Romero (@jorgeamaya).
* Introduces the optional `locus_group` argument for features. Using it,
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@ install.packages("coala")

If you want to use the simulation programs `ms`, `msms` or `seqgen`,
they need to be installed separately. This is described in the
["Using External Simulators" vignette](https://cran.r-project.org/web/packages/coala/vignettes/coala-install.html) and
["Using External Simulators" vignette](https://cran.r-project.org/package=coala/vignettes/coala-install.html) and
in [the wiki](https://github.com/statgenlmu/coala/wiki/Installation).


Usage & Help
------------
Coala comes with a
[vignette](https://cran.r-project.org/web/packages/coala/vignettes/coala-intro.html)
[vignette](https://cran.r-project.org/package=coala/vignettes/coala-intro.html)
that explains the packages concepts and is a good place to start. It also has a
[vignette containing a few example applications](https://cran.r-project.org/web/packages/coala/vignettes/coala-examples.html).
[vignette containing a few example applications](https://cran.r-project.org/package=coala/vignettes/coala-examples.html).

Detailed information about coala's functions is provided via R's help system.
Call `help(_function_)` in R to view them. They usually also contain examples and further links.

The [ABC vignette](https://cran.r-project.org/web/packages/coala/vignettes/coala-abc.html)
The [ABC vignette](https://cran.r-project.org/package=coala/vignettes/coala-abc.html)
gives an example on how coala can be used to conduct the simulations for [Approximate Bayesian
Computation](https://en.wikipedia.org/wiki/Approximate_Bayesian_computation).

Expand All @@ -65,7 +65,7 @@ result$sfs
```

More examples can be found in the
[examples vignette](https://cran.r-project.org/web/packages/coala/vignettes/coala-examples.html).
[examples vignette](https://cran.r-project.org/package=coala/vignettes/coala-examples.html).


Problems
Expand Down Expand Up @@ -96,7 +96,7 @@ devtools::install_github('statgenlmu/coala')

on Linux and OS X. This requires that you have `devtools` and a compiler or
Xcode installed. Bug reports and pull request on GitHub are highly appreciated.
The [extending coala vignette](https://cran.r-project.org/web/packages/coala/vignettes/coala-extend.html)
The [extending coala vignette](https://cran.r-project.org/package=coala/vignettes/coala-extend.html)
contains information on how to create new summary statistics and add simulators
to coala. The [wiki](https://github.com/statgenlmu/coala/wiki) also contains a few
resources for developers.
14 changes: 0 additions & 14 deletions cran-comments.md

This file was deleted.

10 changes: 10 additions & 0 deletions man/feat_mutation.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 30f42c8

Please sign in to comment.