-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.Rmd
More file actions
91 lines (58 loc) · 3.65 KB
/
README.Rmd
File metadata and controls
91 lines (58 loc) · 3.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
---
output:
md_document:
variant: gfm
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# bcEpiRate <a href="https://github.com/bcgov/bcEpiRate"><img src="man/figures/logo.png" align="right" height="138.5"/></a>
<!-- badges: start -->
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md) [](https://opensource.org/licenses/Apache-2.0) [](https://github.com/bcgov/bcEpiRate/actions) [](https://codecov.io/gh/bcgov/bcEpiRate?branch=main)
:toolbox: 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](https://cran.r-project.org/web/packages/dsr/index.html), which has now been removed from the CRAN repository, and the SAS/STAT [STDRATE procedure](https://support.sas.com/documentation/onlinedoc/stat/151/stdrate.pdf). This package is also designed to play nicely with the [tidyverse](https://www.tidyverse.org/), as shown in the vignette.
Curious as to why there's a bathtub on the logo? Check out [this article](https://www.publichealth.hscni.net/node/5277).
### Installation
To install the package from GitHub, you will need the [remotes](https://github.com/r-lib/remotes) package.
```{r eval=FALSE}
install.packages("remotes")
```
Next, install the `bcEpiRate` package along with the vignette using:
```{r eval=FALSE}
remotes::install_github("bcgov/bcEpiRate", build_vignettes = TRUE)
```
### Usage
See the vignette for this package using:
```{r eval=FALSE}
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](https://github.com/bcgov/bcEpiRate/issues/).
### How to Contribute
If you would like to contribute to the package, please see our [CONTRIBUTING](CONTRIBUTING.md) guidelines.
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
### Citation
```{r, echo=FALSE, warning=FALSE, comment=""}
citation("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](https://github.com/bcgov/bcgovr) package.*