Merge branch 'master' of https://github.com/markvanderloo/rtrim

Merging Patrick's with Mark's mods

README.md

@@ -6,18 +6,29 @@
 # rtrim
 Reimplementation of [TRIM](https://www.cbs.nl/en-gb/society/nature-and-environment/indices-and-trends--trim--) for R
 
+### Installation and getting started
 
+To install `rtrim`, issue the following command at the R console.
+```r
+install.packages("rtrim")
+```
 
-### Install the prerelease
-
-Prerelease version 0.9.0 is now available!
-
+To get started, we recommend users to first work through the introductory vignette.This can be opened as follows.
+```r
+library(rtrim)
+vignette("rtrim_for_TRIM_users")
+```
 
-This version is close to being submitted to [CRAN](https://cran.r-project.org). We are
-only setting up some maintainance infrastructure so it is easier for you to contact us once it is published.
+An extended introduction showing all options can be opened as follows:
+```r
+library(rtrim)
+vignette("Skylark_example")
+```
+After working through one of these vignettes, we advise users to have a look atthe help file of `rtrim`'s main function by typing `?trim`. Also, to get a feel of how the package works one can browse through the help files by following thelinks under the `see also` sections in each help file.
 
-To use the prerelease version, please use the following instructions.
+### Install the development version
 
+Sometimes we release a beta version for public testing. Beta versions can be installed as follows.
 
 1. If you are a Windows user, first install [Rtools](https://cran.r-project.org/bin/windows/Rtools/).
 2. Open an R session, and issue the following commands.
@@ -31,50 +42,6 @@ install.packages('rtrim',type='source')
 ```
 This procedure is necessary for the prerelease version. Once the package is on CRAN, installation of neither `Rtools` nor `drat` will be required.
 
-#### What is in the prerelease version?
-
-Everything. The current version is fully compatible with the original TRIM software.
-
-
-- Estimate coeefficients for TRIM model 1
-- Estimate coefficients for TRIM model 2
-- Estimate coefficients TRIM model 3
-- Use of covariates
-- Reuse covariance matrix
-- Estimating serial correlation 
-- Estimating overdispersion
-- Manual changepoint specification (model 2)
-- Stepwise changepoint selection (model 2)
-- Goodness-of-fit: AIC, p-value and Xi-squared
-- Wald test statistic for significance of slopes
-- Computing time totals
-- Computing indices
-- Computing overall slope (slope over multiple pieces of the piecewise linear model)
-- read instructions TRIM command files (for backward compatibility with TRIM)
-- read TRIM data files (for backward compatibility with TRIM)
-- Extracting and reusing covariance matrices
-
-
-
-### Getting started
-
-To get started, we recommend users to first work through the introductory vignette.
-This can be opened as follows.
-```r
-library(rtrim)
-vignette("rtrim_for_TRIM_users")
-```
-
-An extended introduction showing all options can be opened as follows:
-```r
-library(rtrim)
-vignette("Skylark_example")
-```
-
-After working through one of these vignettes, we advise users to have a look at
-the help file of `rtrim`'s main function by typing `?trim`. Also, to get a feel
-of how the package works one can browse through the help files by following the
-links under the `see also` sections in each help file.
 
 
 ### Note
@@ -94,7 +61,7 @@ We would really appreciate it if you let us know using the following instruction
 We'd love to hear your findings. It would be great if you could do this by adding
 issues to our [issues page](https://github.com/markvanderloo/rtrim/issues). You will 
 need to create a github account for that. If you can not or do not want to create one,
-send an e-mail to `mark dot vanderloo @ gmail dot com`.
+send an e-mail to `rtrim AT cbs dot nl`.
 
 When reporting bugs, it helps us a lot if you can create an  as small as possible example
 that demonstrates the error. Some good general guidelines for reporting bugs are given [here](https://sifterapp.com/blog/2012/08/tips-for-effectively-reporting-bugs-and-issues/)