Skip to content

Commit

Permalink
added details of the package
Browse files Browse the repository at this point in the history
  • Loading branch information
davidsantiagoquevedo authored Dec 4, 2024
1 parent 3b3b62e commit 7c84bac
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions posts/vaccineff_v1.0.0/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,29 @@ categories: [new-release]
---

We are very excited to announce the release of a new vaccineff version v1.0.0.
Here is an automatically generated summary of the changes in this version.
The package offers tools for estimating vaccine effectiveness (VE) and related
metrics, with features like:

`{vaccineff 1.0.0}` refactors the package's internal structure for better
maintainability.
* 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.
Expand Down

0 comments on commit 7c84bac

Please sign in to comment.