bcEpiRate

🧰 Tools for standardized rates in population health surveillance and epidemiology

Features

• get_spec_rt() calculates a specific/crude rate and constructs a confidence interval around the estimate.
• get_ds_rt() calculates a directly standardized rate and constructs a confidence interval around the estimate using a user-specified standard population.
• get_smr() calculates a standardized morbidity/mortality ratio and constructs a confidence interval around the estimate.

This package is inspired by the R package dsr, which has now been removed from the CRAN repository, and the SAS/STAT STDRATE procedure. This package is also designed to play nicely with the tidyverse, as shown in the vignette.

Curious as to why there’s a bathtub on the logo? Check out this article.

Installation

To install the package from GitHub, you will need the remotes package.

install.packages("remotes")

Next, install the bcEpiRate package along with the vignette using:

remotes::install_github("bcgov/bcEpiRate", build_vignettes = TRUE)

Usage

See the vignette for this package using:

browseVignettes("bcEpiRate")

Project Status

In the coming months, there are plans to add features for calculating measures of association (e.g., risk ratio, rate ratio).

Getting Help or Reporting an Issue

To report bugs/issues/feature requests, please file an issue.

How to Contribute

If you would like to contribute to the package, please see our CONTRIBUTING guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Citation

To cite package 'bcEpiRate' in publications use:

  Reiko Okamoto, Henry Ngo and Ioana Sevcenco (2022). bcEpiRate: Tools
  for Standardized Rates in Population Health Surveillance and
  Epidemiology. R package version 1.0.1.
  https://github.com/bcgov/bcEpiRate

A BibTeX entry for LaTeX users is

  @Manual{,
    title = {bcEpiRate: Tools for Standardized Rates in Population Health Surveillance and Epidemiology},
    author = {Reiko Okamoto and Henry Ngo and Ioana Sevcenco},
    year = {2022},
    note = {R package version 1.0.1},
    url = {https://github.com/bcgov/bcEpiRate},
  }

License

Copyright 2022 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.

---

This project was created using the bcgovr package.