README.md

In poissonconsulting/kootqlt: West Kootenay Discharge, Elevation and Temperature Data Import

kootqlt

Introduction

An R Package to query discharge, elevation and temperature data from an SQLite database for the West Kootenay region of British Columbia.

The SQLite database which houses the actual data is not provided with the package and must be requested from [e-mail].

Installation

kootqlt is available from GitHub

# install.packages("devtools")
devtools::install_github("poissonconsulting/kootqlt")

or the Poisson R Archive Network (PoisRAN)

# install.packages("drat")
drat::addRepo("poissonconsulting")
install.packages("kootqlt")

Utilization

After installing the kootqlt R package, make sure the SQLite database kootqlt.sqlite is in dir (by default the working directory), select the stations (the tbl data frame kootqlt::station has information on all the possible stations) and date range of interest and then use kootqlt::qlt_download_data() to get the data you need.

The DateTimeReading column in the returned data is the date and time of the reading with time zone Etc/GMT+8 (which corresponds to Pacific Standard Time without daylight savings). To convert to a Date use as.Date(tz = "Etc/GMT+8") or better yet lubridate::date().

Contribution

Please report any issues.

Pull requests are always welcome.

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.

Disclaimer

cat(kootqlt::qlt_disclaimer())
#> This database has been created for the sole purpose of ongoing BC Hydro Water License Requirements (WLR) Studies in the Columbia River Basin.
#> 
#>   BC Hydro expressly disclaims any warranties or representations, either expressed or implied, with respect to this data and information which was compiled solely for BC Hydro purposes.  In no event will BC Hydro or its employees, servants or agents have any obligation arising from contract or tort, or for loss of revenue or profit, or for indirect, special, incidental or consequential damages arising from the use of this data and information.  Any person using this data and information does so at their own risk and acknowledges that such data and information is subject to revision at any time with no obligation on BC Hydro to advise any third party of such revisions.  BC Hydro accepts no liability for the accuracy, availability, suitability, reliability, usability, completeness or timeliness of data and information contained herein.
#> 
#>   This data and information is BC Hydro property.  Distribution of this data and information to any other third party is strictly prohibited without BC Hydro's prior written consent.
#> 
#>   BC Hydro Contacts:
#>   Philip Bradshaw (604-528-1693) [e-mail]
#>   Guy Martel  (604-515-8590) [e-mail]
#> 
#>   If you find errors in the data, please file an issue at https://github.com/poissonconsulting/kootqlt/issues.
#> .

poissonconsulting/kootqlt documentation built on May 25, 2019, 10:25 a.m.