README.Rmd

---
output:
  md_document:
    variant: markdown_github
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```


StMoMo
========================================================

[![Build Status](https://travis-ci.org/amvillegas/StMoMo.svg?branch=master)](https://travis-ci.org/amvillegas/StMoMo)
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/StMoMo)](https://cran.r-project.org/package=StMoMo) ![downloads](https://cranlogs.r-pkg.org/badges/grand-total/StMoMo)

StMoMo (Stochastic Mortality Modelling) is an R package providing functions to specify 
and fit stochastic mortality models including the Lee-Carter models, the CBD model, 
the APC model and many other (possibly new) models. The package also includes tools for 
analysing the goodness of fit of the models and performing mortality projections and simulations.

An overview of the usage and facilities of StMoMo is described in the working paper [Andrés M. Villegas, Pietro Millossovich, Vladimir K. Kaishev. “StMoMo: An R Package for Stochastic Mortality Modelling”](https://github.com/amvillegas/StMoMo/raw/master/inst/doc/StMoMoVignette.pdf)

# Installation:

To install the stable version on R CRAN:

```R
    install.packages("StMoMo")
````

To install the latest development version: 

```R
    install.packages("devtools")
    devtools::install_github("amvillegas/StMoMo")
````

# License:

This package is free and open source software, licensed under GPL (>= 2)

If you are interested in the package feel free to email andresmauriciovillegas@gmail.com
or track development at http://github.com/amvillegas/StMoMo