vaxstats

Help with statistical forecasting models for vaccine studies.

Documentation

vaxstats is a powerful tool designed to support statistical forecasting models tailored specifically for vaccine studies. It provides a robust command-line interface and modular architecture, enabling researchers to efficiently analyze, forecast, and visualize vaccine-related data. This tool is particularly useful in predicting trends and understanding the impact of vaccines over time.

Features

• Data Preparation: Clean and prepare vaccine-related datasets for analysis.
• Forecasting: Apply statistical forecasting models to predict future trends based on historical data.
• Visualization: Generate insightful visualizations to aid in the interpretation of forecasting results.
• Modular Design: Easily extendable with custom models and analysis routines.

Acknowledgements

This project was developed as part of OASCI's Scientific Computing Core (SC2) initiative to enhance interdisciplinary computational research. We appreciate contributions and feedback from the broader community.

In particular, we designed and implemented this software in collaboration with the following group(s):

• Dr. Doug Reed in the Center for Vaccine Research at the University of Pittsburgh.

Installation

Clone the repository:

git clone https://github.com/oasci/vaxstats.git

Conda environment

Move into vaxstats directory (cd vaxstats) and install the development conda environment using GNU Make (which could be installed by default on your system).

make environment

Now you can activate the new conda environment vaxstats-dev and use vaxstats commands.

conda activate vaxstats-dev

Manual install

Alternatively, you can manually install vaxstats using pip after moving into the directory.

pip install .

This will install all dependencies and vaxstats into your current Python environment.

Deploying

We use bump-my-version to release a new version. This will create a git tag used by poetry-dynamic-version to generate version strings and update CHANGELOG.md.

For example, you would run the following command to bump the minor version.

poetry run bump-my-version bump minor

After releasing a new version, you must push and include all tags.

git push --follow-tags

License

This project is released under the Apache-2.0 License as specified in LICENSE.md.