Skip to content

Commit 5e367c0

Browse files
committed
Automatic readme update
1 parent f6d334b commit 5e367c0

File tree

2 files changed

+32
-33
lines changed

2 files changed

+32
-33
lines changed

README.md

+32-33
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,32 @@
11

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"/>
33

44
<!-- badges: start -->
55

66
[![License:
77
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)
99
[![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)
1111
[![Project Status: WIP – Initial development is in progress, but there
1212
has not yet been a stable, usable release suitable for the
1313
public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
1414
[![lifecycle-maturing](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-maturing.svg)](https://www.reconverse.org/lifecycle.html#concept)
1515

1616
<!-- badges: end -->
1717

18-
*{{ packagename }}* is developed at [Pontificia Universidad
18+
*vaccineff* is developed at [Pontificia Universidad
1919
Javeriana](https://www.javeriana.edu.co/inicio) as part of the
2020
[Epiverse-TRACE initiative](https://data.org/initiatives/epiverse/).
2121

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.
3130

3231
## Installation
3332

@@ -37,25 +36,25 @@ Our stable versions are released on CRAN, and can be installed using:
3736
install.packages("vaccineff", build_vignettes = TRUE)
3837
```
3938

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.
4241

4342
``` r
4443
if(!require("pak")) install.packages("pak")
45-
pak::pak("{{ gh_repo }}")
44+
pak::pak("epiverse-trace/vaccineff")
4645
```
4746

4847
Or using the `remotes` package
4948

5049
``` r
5150
if(!require("remotes")) install.packages("remotes")
52-
remotes::install_github("{{ gh_repo }}")
51+
remotes::install_github("epiverse-trace/vaccineff")
5352
```
5453

5554
## Quick start
5655

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.
5958

6059
``` r
6160
# Load example `cohortdata` included in the package
@@ -109,10 +108,10 @@ ve <- estimate_vaccineff(vaccineff_data, at = 180)
109108
summary(ve)
110109
#> Vaccine Effectiveness at 180 days computed as VE = 1 - HR:
111110
#> VE lower.95 upper.95
112-
#> 0.6991 0.4975 0.8199
111+
#> 0.7254 0.5437 0.8347
113112
#>
114113
#> Schoenfeld test for Proportional Hazards assumption:
115-
#> p-value = 0.1273
114+
#> p-value = 0.1507
116115

117116
# Generate loglog plot to check proportional hazards
118117
plot(ve, type = "loglog")
@@ -122,22 +121,21 @@ plot(ve, type = "loglog")
122121

123122
## Package vignettes
124123

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”.
130129

131130
## Help
132131

133132
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).
135134

136135
## Contribute
137136

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).
141139

142140
Contributors to the project include:
143141

@@ -158,14 +156,15 @@ Otero](https://github.com/jd-otero)
158156

159157
## Code of conduct
160158

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
163161
Conduct](https://github.com/epiverse-trace/.github/blob/main/CODE_OF_CONDUCT.md).
164162
By contributing to this project, you agree to abide by its terms.
165163

166164
## References
167165

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">
169168

170169
<div id="ref-bookvaccine" class="csl-entry">
171170

431 Bytes
Loading

0 commit comments

Comments
 (0)