ReadME cleanup

.Rbuildignore

@@ -4,3 +4,4 @@
 ^\.github$
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^README\.Rmd$

DESCRIPTION

@@ -3,7 +3,7 @@ Type: Package
 Title: Water Balance Summary
 Version: 0.1.0
 Maintainer: Billy McLean <[email protected]>
-Description: Create water balance plots, seasonal error plots, compare well water level with soil moisture from baggregated meteorological data.
+Description: Create water balance plots, seasonal error plots, compare well water level with soil moisture from aggregated meteorological data.
 Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.3.2

README.Rmd

@@ -0,0 +1,56 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# WaterBalanceSummary
+
+<!-- badges: start -->
+
+<!-- badges: end -->
+
+The goal of WaterBalanceSummary is to create water balance plots, seasonal error plots, compare well water level with soil moisture from aggregated meteorological data.
+
+## Installation
+
+You can install the development version of WaterBalanceSummary from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("pak")
+pak::pak("lynker-spatial/WaterBalanceSummary")
+```
+
+#### You can use this package to produce detailed figures for analysis of your model compared to real world data.
+
+```{r, echo=FALSE}
+
+knitr::include_graphics(c("vignettes/images/CorrPlotExample.png", "vignettes/images/WWLvsSTR_Example.png"))
+
+```
+
+#### To visualize the water balance of a basin
+
+```{r, echo=FALSE}
+
+knitr::include_graphics("vignettes/images/ExampleBalancePlot.png")
+
+```
+
+#### And to locate where model data and real world data do and do not align
+
+```{r, echo=FALSE}
+
+knitr::include_graphics("vignettes/images/ExampleSeasonPlot.png")
+
+```
+

README.md

@@ -0,0 +1,33 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# WaterBalanceSummary
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+The goal of WaterBalanceSummary is to create water balance plots,
+seasonal error plots, compare well water level with soil moisture from
+aggregated meteorological data.
+
+## Installation
+
+You can install the development version of WaterBalanceSummary from
+[GitHub](https://github.com/) with:
+
+``` r
+# install.packages("pak")
+pak::pak("lynker-spatial/WaterBalanceSummary")
+```
+
+#### You can use this package to produce detailed figures for analysis of your model compared to real world data.
+
+<img src="vignettes/images/CorrPlotExample.png" width="100%" /><img src="vignettes/images/WWLvsSTR_Example.png" width="100%" />
+
+#### To visualize the water balance of a basin
+
+<img src="vignettes/images/ExampleBalancePlot.png" width="100%" />
+
+#### And to locate where model data and real world data do and do not align
+
+<img src="vignettes/images/ExampleSeasonPlot.png" width="100%" />