Skip to content

Commit

Permalink
v1.0.8.9000 - set up GitHub package as development version following …
Browse files Browse the repository at this point in the history
…release to CRAN
  • Loading branch information
PHEgeorginaanderson committed Jul 31, 2018
1 parent 805d4bf commit 0d8ca47
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 40 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: PHEindicatormethods
Type: Package
Version: 1.0.8
Version: 1.0.8.9000
Title: Common Public Health Statistics and their Confidence Intervals
Description: Functions to calculate commonly used public health statistics and
their confidence intervals using methods approved for use in the production
Expand Down
5 changes: 4 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
## V1.0.6
## v1.0.9


## V1.0.8
This is the first release of this package to CRAN
38 changes: 31 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,27 @@ Status](https://coveralls.io/repos/github/PublicHealthEngland/PHEindicatormethod

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
Any feedback would be appreciated and can be provided using the Issues section of the GitHub repository https://github.com/PublicHealthEngland/PHEindicatormethods, 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:
#### Install from CRAN

Install the latest release version of PHEindicatormethods directly from CRAN with:

``` {r install from CRAN, eval=FALSE}
install.packages("PHEindicatormethods")
```



#### Install a development version from GitHub using devtools

You can install a development version of PHEindicatormethods from GitHub with:

``` {r devtools-installation, eval=FALSE}
if (!require(devtools)) install.packages("devtools")
Expand All @@ -44,13 +55,15 @@ devtools::install_github("PublicHealthEngland/PHEindicatormethods",
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:
#### Install a development version from zip

Download the PHEindicatormethods repository from GitHub https://github.com/PublicHealthEngland/PHEindicatormethods and either build from source or do:

```{r source_pkg-installation, eval = FALSE}
if (!require(devtools)) install.packages("devtools")
source <- devtools:::source_pkg("C:/path/to/PHEindicatormethods-master")
devtools::install(source)
```
Expand All @@ -63,16 +76,23 @@ devtools::install(source)
## 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>
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

<br/>
<br/>


## 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
Expand All @@ -85,10 +105,14 @@ The package contains the following functions, datasets and vignettes - see indiv
- wilson_upper

**Datasets:**

- esp2013

**Vignettes:**

- Vignette to introduce the package functions included in the original package release
- Vignette for calculating DSRs for multiple geographies and time periods

(type 'browseVignettes("PHEindicatormethods")' to view in HTML)


83 changes: 52 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,26 @@ 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>
section of the GitHub repository
<https://github.com/PublicHealthEngland/PHEindicatormethods>, or by
emailing <PHDS@phe.gov.uk>

<br/> <br/>

## Installation

#### From GitHub using devtools
#### Install from CRAN

You can install the latest version of PHEindicatormethods from GitHub
Install the latest release version of PHEindicatormethods directly from
CRAN with:

``` r
install.packages("PHEindicatormethods")
```

#### Install a development version from GitHub using devtools

You can install a development version of PHEindicatormethods from GitHub
with:

``` r
Expand All @@ -35,16 +46,15 @@ devtools::install_github("PublicHealthEngland/PHEindicatormethods",
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.
#### Install a development version from zip

#### From zip

Download this repository from GitHub and either build from source or do:
Download the PHEindicatormethods repository from GitHub
<https://github.com/PublicHealthEngland/PHEindicatormethods> and either
build from source or do:

``` r
if (!require(devtools)) install.packages("devtools")

source <- devtools:::source_pkg("C:/path/to/PHEindicatormethods-master")
devtools::install(source)
```
Expand All @@ -59,34 +69,45 @@ 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.
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

<br/> <br/>

## 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
**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 to introduce the package functions included in the original
package release
- Vignette for calculating DSRs for multiple geographies and time
periods

(type ‘browseVignettes(“PHEindicatormethods”)’ to view in HTML)

0 comments on commit 0d8ca47

Please sign in to comment.