README.md

In gmp26/funnel: Provides a function which plots mortality data in funnels or slices

funnel

Provides an R function to plot mortality rates in funnel or slice form.

This is an R package under development and is not ready for use.

Usage

To use from another RStudio project, install the devtools package, and then load the funnel package like this:

devtools::install_github("gmp26/funnel")
library(funnel)
?funnel4

Development

Setup

Create a new RStudio version controlled project from this distribution.

Note that the package is now configured to build documentation and vignettes on Build and Load. This may require LaTeX and XCode to run - see below. To build without documentation, use Build > More > Conigure Build Tools..., and revise the roxygen configuration options.

See Package Development Prerequisites. Generating documentation requires a working C++ compiler and \LaTeX. On MacOSX this amounts to installing XCode and LaTeX so the documentation can be built.

Workflow

• Revise code
• Rebuild package using Build > Build & Reload in the top right panel
• Commit changes and push back to GitHub
• Test interactively by loading the package into shiny-funnel-app
• Parallel test by running Build and Load and looking at the vignette outputs.
• Package check runs a minimal sanity test.

We could do with adding some local tests in this package so we don't need to push changes to test.

Contributions

Unsolicited contributions are welcome as pull requests. Please first raise an issue here in case the change is already planned.

To do

• [ ] Rename funnel4 to funnel?
• [x] Add local tests
• [ ] Finish basic plot function, and stabilise parameters
• [ ] Improve inline docs
• [ ] Add vignettes

gmp26/funnel documentation built on May 17, 2019, 7:28 a.m.