README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

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


# WINS - crop stress *W*eather *IN*formation delivery *S*ystem

## About
WINS is an R-package constructed as a part of GovHack 2016.

The _WINS_ project (formerly called [*John_Conner*](https://github.com/ToowoombaTrio/John_Conner)) was initiated by the Toowoomba Trio to tackle a major and growing problem faced by Queensland vegetable growers. This challenge is identifying and responding to heat stress in their crops. High temperatures can cause considerable stress to crops, reducing yields and the quality of the produce grown. However, if the stress is identified early enough remedial action can be taken to minimise the damage and save the crop. _WINS_ provides a timely warning system for farmers when a heat stress event has likely occurred. The _WINS_ project is built in the R environment, an open source statistical programing environment and utilises Australia Bureau of Meteorology (BOM) weather data.

Please watch our [YouTube video](https://m.youtube.com/watch?v=yECTDHx794E
https://github.com/ToowoombaTrio/John_Conner) describing the *John_Conner* project for more on how _WINS_ was created and works.

![Comparison of hourly interpolated values versus hourly BoM data for one year](man/figures/Fit_hexbin.png)

# Quick Start

This package is only available from GitHub, not yet on CRAN, so you'll need _devtools_ to install it.

```{r, eval=FALSE}
if (!require("devtools")) {
  install.packages("devtools", repos = "http://cran.rstudio.com/") 
  library("devtools")
}

devtools::install_github("ToowoombaTrio/WINS")
library("WINS")
```


# Meta
If you find bugs or other issues, please report them to us using https://github.com/ToowoombaTrio/WINS/issues.


Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.