This repository contains R code that generates aquifer factsheets for British Columbia.

The data sourced for the analyses is provided under the Open Government Licence – British Columbia.

Data used by, but not created in, these scripts are stored in the "./data/" folder and include:

Groundwater Trends Full Data (Temporary data, future to be accessed from finalized BC Groundwater datasets)

• clean_well_data.RData

Miscellaneous

• Piper Plot descriptions (piper_text.xlsx)
• Index of extra page types (extra_page_index.xlsx)
• Images to include on extra pages (extra_page_images.xlsx)

Data sets downloaded for use in these scripts (automatically downloaded by the 00_download.R script) are stored in the "./data_dl/" folder and include:

• Daily mean water levels in observation wells (obs_well_daily_mean.csv)
• Well data from GWELLS (well.csv & lithology.csv)
• University of Victoria aquifer stress test results (uvic_stress_index.xlsx)
• Water licences (licenced_vol.csv)
• Aquifer data (aquifers.csv)
• Aquifer subtype index (aquifer_subtypes.csv)
• Aquifer map (./data_dl/aquifer_map.rds)
• Groundwater trends - summarized (groundwater_trends.csv)

Some figures are created as part of the analysis, some are created in other software. Additional figures used by, but not created in, these scripts are stored in the "./figures/" folder:

• ./figures/maps/ - Aquifer maps (i.e., Aquifer_Map_0001.pdf)
• ./figures/piperplots/ - Piper plots (i.e., Piperplot_0001_OW0001.jpg)
• ./figures/na/ - Missing plot figures for Combo, Piper plots and Trend plots
• ./figures/boxplot_key.png - Figure explaining the boxplots for the companion document
• ./figures/BCID_H_cmyk_rev.pdf - BC Gov Logo

**To get the BC Government logo: **

Download BC Government logo and unzip into figures folder (Then convert to pdf by hand)

if(!file.exists("./figures/BCID_H_cmyk_rev.eps")) {
  download.file(url = "http://www.corporate.gov.bc.ca/print-ads/Govt_of_BC_Logos/Resources/2018_BCID_Files.zip",
                dest = "./figures/2018_BCID_Files.zip")
  unzip(zipfile = "./figures/2018_BCID_Files.zip",
        files = "2018_BCID_Files/_Horizontal/Reverse/CMYK/BCID_H_cmyk_rev.eps",
        exdir = "./figures", junkpaths = TRUE)
  file.remove("./figures/2018_BCID_Files.zip")
}

There are four core scripts that are required for the analysis, they need to be run in order:

• 01_download.R
• 02_load.R
• 03_clean.R
• 04_output.R

To create all factsheets, it is best to use the helper script: run_all.R

This script will guide the user through aquifer selection and running the required analysis scripts sequentially.

Each script will first run the 00_header.R script file which will ensure the correct folder structure and will install and load all relevant packages.

An installation of LaTeX (e.g. MiKTex, MacTeX or tinytex) is required to render the .Rmd files to PDF with knitr.

These scripts output Aquifer Factsheets and the Aquifer Factsheet Companion document to the "./factsheets/" folder.

• Factsheet for each Aquifer (e.g., for Aquifer #1 AQ_00001_Aquifer_Factsheet.pdf)
• A companion document containing methodological details (Aquifer Factsheet - Companion Document.pdf)

This project is under development.

To report bugs/issues/feature requests, please file an issue.

If you would like to contribute, please see our CONTRIBUTING guidelines.

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

Copyright 2020 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
for the specific language governing permissions and limitations under the
License.

This repository is maintained by the ENVWater Team in the GitHub BCGov Organization.

This project was created using the bcgovr package.