Merge pull request #1 from PublicHealthEngland/dev1_0_6

Dev1 0 6

.Rbuildignore

@@ -1,4 +1,7 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
-README.Rmd
+^README\.Rmd$
+^README_files
+cran-comments.md
+^\.travis\.yml$
 data-raw

DESCRIPTION

@@ -1,16 +1,16 @@
 Package: PHEindicatormethods
 Type: Package
-Version: 1.0.6
+Version: 1.0.7
 Title: Common Public Health Statistics and their Confidence Intervals 
 Description: Functions to calculate commonly used public health statistics and their confidence intervals.
     Includes the following functions:
     1. confidence limits for observed number of events using Wilson Score method.
     2. confidence limits for observed number of events using Byar's method.
-    3. proportions and their CIs using Wilson score method.
-    4. rates and their CIs using Byar's or exact Poisson method.
-    5. DSRs and their CIs using Dobson method.
-    6. ISRs and their CIs using Byar's or exact Poisson method. 
-    7. SMRs and their CIs using Byar's or exact Poisson method. 
+    3. proportions and their confidence intervals using Wilson score method.
+    4. rates and their confidence intervals using Byar's or exact Poisson method.
+    5. directly standardised rates and their confidence intervals using Dobson method.
+    6. indirectly standardised rates and their confidence intervals using Byar's or exact Poisson method. 
+    7. standardised mortality ratios and their confidence intervals using Byar's or exact Poisson method. 
 Authors@R: c(person("Anderson", "Georgina", , "georgina.anderson@phe.gov.uk", c("aut", "cre")),
              person("Fox", "Sebastian", , "sebastian.fox@phe.gov.uk", c("ctb")),
              person("Francis", "Matthew", , "matthew.francis@phe.gov.uk", c("ctb")),

NEWS.md

@@ -0,0 +1,2 @@
+## V1.0.6
+This is the first release of this package to CRAN

cran-comments.md

@@ -0,0 +1,75 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+[![Build Status](https://travis-ci.org/PublicHealthEngland/PHEindicatormethods.svg)](https://travis-ci.org/PublicHealthEngland/PHEindicatormethods)
+
+[![Coverage Status](https://coveralls.io/repos/github/PublicHealthEngland/PHEindicatormethods/badge.svg?branch=master)](https://coveralls.io/github/PublicHealthEngland/PHEindicatormethods?branch=master)
+
+PHEindicatormethods
+===================
+
+This is an R package to support analysts in the execution of statistical methods approved for use in the production of PHE indicators such as those presented via Fingertips. It provides functions for the generation of Proportions, Rates, DSRs, ISRs, SMRs and Means including confidence intervals for these statistics.
+
+Any feedback would be appreciated and can be provided using the Issues section of the GitHub repository, or by emailing <PHDS@phe.gov.uk>
+
+<br/> <br/>
+
+Installation
+------------
+
+#### From GitHub using devtools
+
+You can install the latest version of PHEindicatormethods from GitHub with:
+
+``` r
+if (!require(devtools)) install.packages("devtools")
+
+devtools::install_github("PublicHealthEngland/PHEindicatormethods",
+                         build_vignettes = TRUE,
+                         dependencies = "suggests")
+```
+
+Some users may receive a Lazy Load error following installation and loading of this package using devtools in RStudio. In these cases, please close and re-open RStudio and then re-load the package using the library command.
+
+#### From zip
+
+Download this repository from GitHub and either build from source or do:
+
+``` r
+source <- devtools:::source_pkg("C:/path/to/PHEindicatormethods-master")
+devtools::install(source)
+```
+
+<br/> <br/>
+
+Package Versioning
+------------------
+
+Following installation of this package, type 'packageVersion("PHEindicatormethods")' in the R console to show the package version. If it is suffixed with a 9000 number then you are using an unapproved development version.
+
+Released versions of this package will have version numbers consisting of three parts: <major>.<minor>.<patch> In-development versions of this package will have a fourth component, the development version number, which will increment from 9000.
+
+See <http://r-pkgs.had.co.nz/description.html> for further information on package versioning
+
+Package Contents
+----------------
+
+The package contains the following functions, datasets and vignettes - see individual item documentation for full details
+
+**Functions:**
+- byars\_lower
+- byars\_upper
+- phe\_dsr
+- phe\_isr
+- phe\_mean
+- phe\_proportion
+- phe\_rate
+- phe\_smr
+- wilson\_lower
+- wilson\_upper
+
+**Datasets:**
+- esp2013
+
+**Vignettes:**
+- Vignette for calculating DSRs for multiple geographies and time periods
+(type 'browseVignettes("PHEindicatormethods")' to view in HTML)