Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automated release blog post vaccineff - v1.0.0 #346

Merged
merged 9 commits into from
Dec 4, 2024
57 changes: 57 additions & 0 deletions posts/vaccineff_v1.0.0/index.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: "vaccineff v1.0.0"
author:
- name: "The Epiverse-TRACE development team"
date: "2024-12-02"
categories: [new-release]
---

We are very excited to announce the release of a new vaccineff version v1.0.0.
davidsantiagoquevedo marked this conversation as resolved.
Show resolved Hide resolved
The package offers tools for estimating vaccine effectiveness (VE) and related
metrics, with features such as:

* Estimation in a cohort study design via the Cox model for Proportional Hazards
* Controlling for confounders through an iterative matching algorithm
* A detailed vignette with illustrative examples

Two main functions compose `{vaccineff 1.0.0}`:

1. `make_vaccineff_data()`: Constructs the `vaccineff_data` class, managing key
features for preparing, visualizing, and organizing cohort data.

2. `estimate_vaccineff()`: Constructs the `vaccineff` class, enabling estimation
of VE and assessment of results and model performance.

Both classes support `plot()` and `summary()` methods, providing visualizations
and detailed reports.

## Breaking Changes

`{vaccineff 1.0.0}` refactors the package's internal structure for better
maintainability.

* **`estimate_vaccineff()`** replaces `effectiveness()`.
* It returns an object of class `vaccineff`.
* The `at` parameter must always be provided for accurate results.

* **`plot.vaccineff_data()`** replaces `plot_coverage()`.

* **`cohortdata`** has been simplified and reduced to improve examples and
reduce computation time.

## Acknowledgements

```{r ctbs, results='asis', echo=FALSE, message = FALSE}
releases <- gh::gh("GET /repos/{owner}/{repo}/releases",
owner = "epiverse-trace",
repo = "vaccineff") |>
purrr::discard(~ grepl("\\d+\\.\\d+\\.[1-9]\\d*$", .x$tag_name))

ctbs <- usethis::use_tidy_thanks(
"epiverse-trace/vaccineff",
from = releases[[2]][["tag_name"]],
to = "v1.0.0"
)
ctbs <- ctbs[grep("github-actions\\[bot\\]", ctbs, invert = TRUE)]
cat(glue::glue("[&#x0040;{ctbs}](https://github.com/{ctbs})"))
```
Loading