Skip to content

Commit

Permalink
Automatic readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user authored and davidsantiagoquevedo committed May 6, 2024
1 parent bbe6572 commit a5dd9a2
Showing 1 changed file with 27 additions and 26 deletions.
53 changes: 27 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@

## *{{ packagename }}*: An R package with tools for estimating vaccine effectiveness and vaccine related metrics <img src="man/figures/vaccineff.png" align="right" width="130"/>
## *vaccineff*: An R package with tools for estimating vaccine effectiveness and vaccine related metrics <img src="man/figures/vaccineff.png" align="right" width="130"/>

<!-- badges: start -->

[![License:
MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit/)
[![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)
[![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)
[![Codecov test
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)
coverage](https://codecov.io/gh/epiverse-trace/vaccineff/branch/main/graph/badge.svg)](https://app.codecov.io/gh/epiverse-trace/vaccineff?branch=main)
[![Project Status: WIP – Initial development is in progress, but there
has not yet been a stable, usable release suitable for the
public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![CRAN
status](https://www.r-pkg.org/badges/version/%7B%7B%20packagename%20%7D%7D)](https://CRAN.R-project.org/package=%7B%7B%20packagename%20%7D%7D)
status](https://www.r-pkg.org/badges/version/vaccineff)](https://CRAN.R-project.org/package=vaccineff)
[![lifecycle-experimental](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-experimental.svg)](https://www.reconverse.org/lifecycle.html#concept)

<!-- badges: end -->

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

*{{ packagename }}* is an R package that offers tools for estimating
vaccine effectiveness, using a series of epidemiological designs
including cohort studies, test-negative case-control, and screening
methods ([Torvaldsen and McIntyre 2002](#ref-torvaldsen2002)). The
current version of the package provides a set of features for preparing,
*vaccineff* is an R package that offers tools for estimating vaccine
effectiveness, using a series of epidemiological designs including
cohort studies, test-negative case-control, and screening methods
([Torvaldsen and McIntyre 2002](#ref-torvaldsen2002)). The current
version of the package provides a set of features for preparing,
visualizing, and managing cohort data, estimating vaccine effectiveness,
and assessing the performance of the models. Test-negative design and
screening method will be included in future versions.

## Installation

The current development version of *{{ packagename }}* can be installed
from [GitHub](https://github.com/) using the `pak` package.
The current development version of *vaccineff* can be installed from
[GitHub](https://github.com/) using the `pak` package.

``` r
if(!require("pak")) install.packages("pak")
pak::pak("{{ gh_repo }}")
pak::pak("epiverse-trace/vaccineff")
```

## Quick start

*{{ packagename }}* provides a minimal cohort dataset that can be used
to test out the models.
*vaccineff* provides a minimal cohort dataset that can be used to test
out the models.

``` r
# Load example `cohortdata` included in the package
Expand All @@ -65,21 +65,21 @@ head(cohortdata, 5)

## Package vignettes

More details on how to use *{{ packagename }}* can be found in the
[online documentation as package
vignettes](https://epiverse-trace.github.io/%7B%7B%20packagename%20%7D%7D/),
in the article “Get Started with vaccineff”.
More details on how to use *vaccineff* can be found in the [online
documentation as package
vignettes](https://epiverse-trace.github.io/vaccineff/), in the article
“Get Started with vaccineff”.

## Help

To report a bug or to request a new feature please open an
[issue](https://github.com/%7B%7B%20gh_repo%20%7D%7D/issues/new/choose).
[issue](https://github.com/epiverse-trace/vaccineff/issues/new/choose).

## Contribute

Contributions to *{{ packagename }}* are welcomed. Please follow the
[package contributing
guide](https://github.com/%7B%7B%20gh_repo%20%7D%7D/blob/main/.github/CONTRIBUTING.md).
Contributions to *vaccineff* are welcomed. Please follow the [package
contributing
guide](https://github.com/epiverse-trace/vaccineff/blob/main/.github/CONTRIBUTING.md).

Contributors to the project include:

Expand All @@ -98,14 +98,15 @@ Abril-Bermúdez](https://github.com/fsabrilb)

## Code of conduct

Please note that the *{{ packagename }}* project is released with a
[Contributor Code of
Please note that the *vaccineff* project is released with a [Contributor
Code of
Conduct](https://github.com/epiverse-trace/.github/blob/main/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.

## References

<div id="refs" class="references csl-bib-body hanging-indent">
<div id="refs" class="references csl-bib-body hanging-indent"
entry-spacing="0">

<div id="ref-torvaldsen2002" class="csl-entry">

Expand Down

0 comments on commit a5dd9a2

Please sign in to comment.