/fhpredict

R Package for the Project Flusshygiene

Primary LanguageRMIT LicenseMIT

Appveyor build Status Travis build Status codecov Project Status CRAN_Status_Badge DOI

fhpredict

This R package provides all functions that are required for the Web application that is developed within the Flusshygiene project.

Installation

#install.packages("remotes", repos = "https://cloud.r-project.org")
remotes::install_github("KWB-R/fhpredict")

Setup

The function get_radolan_urls_bucket() requires two environment variables to be set:

  • FHPREDICT_RADOLAN_API_URL_PROD: Endpoint to the service that returns URLs to Radolan files,
  • FHPREDICT_RADOLAN_API_TOKEN_PROD: token that is required to access the endpoint.

All functions that make requests to the Postgres API require the following environment variables to be set:

  • FHPREDICT_PG_API_URL
  • AUTH0_REQ_URL
  • AUTH0_CLIENT_ID
  • AUTH0_CLIENT_SECRET
  • AUTH0_AUDIENCE

The following additional envirionment variables are required to download Radolan files from the AWS S3 server:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_DEFAULT_REGION

Main functions

Documentation

Release: https://kwb-r.github.io/fhpredict

Development: https://kwb-r.github.io/fhpredict/dev