https://github.com/kwb-r/fhpredict

R Package for the Project Flusshygiene
https://github.com/kwb-r/fhpredict

project-flusshygiene r r-package rstats

Last synced: 8 days ago
JSON representation

R Package for the Project Flusshygiene

• Host: GitHub
• URL: https://github.com/kwb-r/fhpredict
• Owner: KWB-R
• License: mit
• Created: 2019-02-18T14:18:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-02-19T15:30:43.000Z (over 3 years ago)
• Last Synced: 2023-04-04T02:53:09.923Z (over 1 year ago)
• Topics: project-flusshygiene, r, r-package, rstats
• Language: R
• Homepage: https://kwb-r.github.io/fhpredict
• Size: 1.25 MB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Appveyor build Status](https://ci.appveyor.com/api/projects/status/github/KWB-R/fhpredict?branch=master&svg=true)](https://ci.appveyor.com/project/KWB-R/fhpredict/branch/master)

[![Travis build Status](https://travis-ci.org/KWB-R/fhpredict.svg?branch=master)](https://travis-ci.org/KWB-R/fhpredict)

[![codecov](https://codecov.io/github/KWB-R/fhpredict/branch/master/graphs/badge.svg)](https://codecov.io/github/KWB-R/fhpredict)

[![Project Status](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/fhpredict)]()

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3386817.svg)](https://doi.org/10.5281/zenodo.3386817)

# fhpredict

This R package provides all functions that are

required for the Web application that is developed within the

[Flusshygiene](https://www.kompetenz-wasser.de/en/project/flusshygiene/) project.

## Installation

```r

#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

* [`provide_rain_data()`](https://kwb-r.github.io/fhpredict/dev/reference/provide_rain_data.html)

* [`build_model()`](https://kwb-r.github.io/fhpredict/dev/reference/build_model.html)

* [`predict_quality()`](https://kwb-r.github.io/fhpredict/dev/reference/predict_quality.html)

## Documentation

Release: [https://kwb-r.github.io/fhpredict](https://kwb-r.github.io/fhpredict)

Development: [https://kwb-r.github.io/fhpredict/dev](https://kwb-r.github.io/fhpredict/dev)