Skip to contents

healthiar

Introduction

healthiar is an R package to quantify and monetize health impacts attributable to exposure (e.g. air pollution, noise…) in your study area. Explore the many functions and features of healthiar!

Getting started

To get started with the healthiar R package, we recommend to look at the vignette (~ package manual) intro_to_healthiar, which you cou can access

  1. on the package website (recommended)

  2. in R Studio: Click on the Packages tab in RStudio, scroll down to the healthiar package and clicking on the hyperlinks healthiar > User guides, package vignettes and other documentation

  3. in the web browser: Run browseVignettes("healthiar") in the R console and the page will open up in your browser

Additionally, a 45 minutes introduction to the package can be found here. The slides of the presentation can be found here

See the function help pages for information about specific functions. In RStudio, you can access the function documentation of e.g. the function attribute_health by

  1. going to the [reference page of the package website]{https://swisstph.github.io/healthiar/reference/index.html}

  2. running ?attribute_health in RStudio (with healthiar loaded)

  3. going to the Packages tab and then clicking on healthiar

Installation

We recommend to frequently install the newest healthiar version. Please note that healthiar requires R version 4.3.0 or higher. There are two options to install healthiar:

  1. From CRAN: Click on the Packages tab in RStudio and on the Install button. Leave the Install from: option set to Reporsitory (CRAN) and then search and select healthiar and finally click on Install, keeping Install dependencies activated.

  2. From Github (most recent version): Run the following commands below in RStudio to install healthiar:

  • install.packages(c("knitr", "rmarkdown"))
  • remotes::install_github(repo = "SwissTPH/healthiar", build_vignettes = TRUE)
  • Note: install or update all package dependencies (= other packages that are needed for healthiar) if you get asked to do so

After installation, do not forget to load the package by running the call library(healthiar).

Citation

We love that you use healthiar. In that case, please do not forget to cite healthiar in your work. Three options to get there:

  1. On the healthiar package website

  2. See CITATION.R

  3. In your R console, enter citation(“healthiar”).

In options b) and c), you always see the updated citation. In option a), you see citation of the healthiar version that you have installed locally, which might be outdated.

Disclamer and licence

By using healthiar, you confirm that you agree with the following disclaimer and terms of the licence:

  1. Disclaimer: The R package healthiar is work in progress and the developers are not liable for the results.

  2. License: Available here.

Feedback

Feel free provide feedback via GitHub issues

Presenting healthiar

If you would like us to present healthiar at a conference, lecture or training, please, contact us: and

Acknowledgements

healthiar was been developed under the framework of EU project BEST-COST. BEST-COST is funded by the European Union’s Horizon Europe programme under Grant Agreement No.101095408.