1
1
2
- ## * {{ packagename }} * : Tools for estimating vaccine effectiveness and vaccine related metrics <img src =" man/figures/logo.png " align =" right " width =" 130 " />
2
+ ## * vaccineff * : Tools for estimating vaccine effectiveness and vaccine related metrics <img src =" man/figures/logo.png " align =" right " width =" 130 " />
3
3
4
4
<!-- badges: start -->
5
5
6
6
[ ![ License:
7
7
MIT] ( https://img.shields.io/badge/License-MIT-blue.svg )] ( https://opensource.org/license/mit )
8
- [ ![ R-CMD-check] ( https://github.com/%7B%7B%20gh_repo%20%7D%7D/ actions/workflows/R-CMD-check.yaml/badge.svg )] ( https://github.com/%7B%7B%20gh_repo%20%7D%7D /actions/workflows/R-CMD-check.yaml )
8
+ [ ![ R-CMD-check] ( https://github.com/epiverse-trace/vaccineff/ actions/workflows/R-CMD-check.yaml/badge.svg )] ( https://github.com/epiverse-trace/vaccineff /actions/workflows/R-CMD-check.yaml )
9
9
[ ![ Codecov test
10
- coverage] ( https://codecov.io/gh/%7B%7B%20gh_repo%20%7D%7D/ branch/main/graph/badge.svg )] ( https://app.codecov.io/gh/%7B%7B%20gh_repo%20%7D%7D ?branch=main )
10
+ coverage] ( https://codecov.io/gh/epiverse-trace/vaccineff/ branch/main/graph/badge.svg )] ( https://app.codecov.io/gh/epiverse-trace/vaccineff ?branch=main )
11
11
[ ![ Project Status: WIP – Initial development is in progress, but there
12
12
has not yet been a stable, usable release suitable for the
13
13
public.] ( https://www.repostatus.org/badges/latest/wip.svg )] ( https://www.repostatus.org/#wip )
14
14
[ ![ lifecycle-maturing] ( https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-maturing.svg )] ( https://www.reconverse.org/lifecycle.html#concept )
15
15
16
16
<!-- badges: end -->
17
17
18
- * {{ packagename }} * is developed at [ Pontificia Universidad
18
+ * vaccineff * is developed at [ Pontificia Universidad
19
19
Javeriana] ( https://www.javeriana.edu.co/inicio ) as part of the
20
20
[ Epiverse-TRACE initiative] ( https://data.org/initiatives/epiverse/ ) .
21
21
22
- * {{ packagename }}* is an R package that offers tools for estimating
23
- vaccine effectiveness (VE), using a series of epidemiological designs
24
- including cohort studies, test-negative case-control, and screening
25
- methods ([ Halloran, Longini, and Struchiner 2010] ( #ref-bookvaccine ) ).
26
- The current version of the package provides a set of features for
27
- preparing, visualizing, and managing cohort data, estimating vaccine
28
- effectiveness, and assessing the performance of the models.
29
- Test-negative design and screening method will be included in future
30
- versions.
22
+ * vaccineff* is an R package that offers tools for estimating vaccine
23
+ effectiveness (VE), using a series of epidemiological designs including
24
+ cohort studies, test-negative case-control, and screening methods
25
+ ([ Halloran, Longini, and Struchiner 2010] ( #ref-bookvaccine ) ). The
26
+ current version of the package provides a set of features for preparing,
27
+ visualizing, and managing cohort data, estimating vaccine effectiveness,
28
+ and assessing the performance of the models. Test-negative design and
29
+ screening method will be included in future versions.
31
30
32
31
## Installation
33
32
@@ -37,25 +36,25 @@ Our stable versions are released on CRAN, and can be installed using:
37
36
install.packages(" vaccineff" , build_vignettes = TRUE )
38
37
```
39
38
40
- The current development version of * {{ packagename }} * can be installed
41
- from [ GitHub] ( https://github.com/ ) using the ` pak ` package.
39
+ The current development version of * vaccineff * can be installed from
40
+ [ GitHub] ( https://github.com/ ) using the ` pak ` package.
42
41
43
42
``` r
44
43
if (! require(" pak" )) install.packages(" pak" )
45
- pak :: pak(" {{ gh_repo }} " )
44
+ pak :: pak(" epiverse-trace/vaccineff " )
46
45
```
47
46
48
47
Or using the ` remotes ` package
49
48
50
49
``` r
51
50
if (! require(" remotes" )) install.packages(" remotes" )
52
- remotes :: install_github(" {{ gh_repo }} " )
51
+ remotes :: install_github(" epiverse-trace/vaccineff " )
53
52
```
54
53
55
54
## Quick start
56
55
57
- * {{ packagename }} * provides a minimal cohort dataset that can be used
58
- to test out the models.
56
+ * vaccineff * provides a minimal cohort dataset that can be used to test
57
+ out the models.
59
58
60
59
``` r
61
60
# Load example `cohortdata` included in the package
@@ -109,10 +108,10 @@ ve <- estimate_vaccineff(vaccineff_data, at = 180)
109
108
summary(ve )
110
109
# > Vaccine Effectiveness at 180 days computed as VE = 1 - HR:
111
110
# > VE lower.95 upper.95
112
- # > 0.6991 0.4975 0.8199
111
+ # > 0.7254 0.5437 0.8347
113
112
# >
114
113
# > Schoenfeld test for Proportional Hazards assumption:
115
- # > p-value = 0.1273
114
+ # > p-value = 0.1507
116
115
117
116
# Generate loglog plot to check proportional hazards
118
117
plot(ve , type = " loglog" )
@@ -122,22 +121,21 @@ plot(ve, type = "loglog")
122
121
123
122
## Package vignettes
124
123
125
- More details on how to use * {{ packagename }} * can be found in the
126
- [ online documentation as package
127
- vignettes] ( https://epiverse-trace.github.io/%7B%7B%20packagename%20%7D%7D / ) ,
128
- and in the articles “Get Started with vaccineff” and “Introduction to
129
- cohort design with vaccineff”.
124
+ More details on how to use * vaccineff * can be found in the [ online
125
+ documentation as package
126
+ vignettes] ( https://epiverse-trace.github.io/vaccineff / ) , and in the
127
+ articles “Get Started with vaccineff” and “Introduction to cohort design
128
+ with vaccineff”.
130
129
131
130
## Help
132
131
133
132
To report a bug or to request a new feature please open an
134
- [ issue] ( https://github.com/%7B%7B%20gh_repo%20%7D%7D /issues/new/choose ) .
133
+ [ issue] ( https://github.com/epiverse-trace/vaccineff /issues/new/choose ) .
135
134
136
135
## Contribute
137
136
138
- Contributions to * {{ packagename }}* are welcomed. Contributions are
139
- welcome via [ pull
140
- requests] ( https://github.com/%7B%7B%20gh_repo%20%7D%7D/pulls ) .
137
+ Contributions to * vaccineff* are welcomed. Contributions are welcome via
138
+ [ pull requests] ( https://github.com/epiverse-trace/vaccineff/pulls ) .
141
139
142
140
Contributors to the project include:
143
141
@@ -158,14 +156,15 @@ Otero](https://github.com/jd-otero)
158
156
159
157
## Code of conduct
160
158
161
- Please note that the * {{ packagename }} * project is released with a
162
- [ Contributor Code of
159
+ Please note that the * vaccineff * project is released with a [ Contributor
160
+ Code of
163
161
Conduct] ( https://github.com/epiverse-trace/.github/blob/main/CODE_OF_CONDUCT.md ) .
164
162
By contributing to this project, you agree to abide by its terms.
165
163
166
164
## References
167
165
168
- <div id =" refs " class =" references csl-bib-body hanging-indent " >
166
+ <div id="refs" class="references csl-bib-body hanging-indent"
167
+ entry-spacing="0">
169
168
170
169
<div id =" ref-bookvaccine " class =" csl-entry " >
171
170
0 commit comments