-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
99 lines (74 loc) · 4.22 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r options, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# kgsr
[](http://www.repostatus.org/#wip)
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://travis-ci.org/emraher/kgsr)
[](https://ci.appveyor.com/project/emraher/kgsr)
[](http://www.r-pkg.org/pkg/kgsr)
[](http://www.r-pkg.org/pkg/kgsr)
[](https://codecov.io/github/emraher/kgsr?branch=master)
## Disclaimer
This software is in no way affiliated, endorsed, or approved by the [Kansas Geological Survey - The University of Kansas](http://www.kgs.ku.edu/). It comes with absolutely no warranty.
## Overview
`kgsr` is an R "interface" to KGS. It can download data from [Kansas Geological Survey - The University of Kansas](http://www.kgs.ku.edu/).
## Installation
You can install `kgsr` from github with:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("emraher/kgsr")
```
## Data on KGS
* [Water](http://www.kgs.ku.edu/Hydro/hydroIndex.html)
* [Kansas Master Ground-Water Well Inventory](http://hercules.kgs.ku.edu/geohydro/master_well/index.cfm)
* [Energy](http://www.kgs.ku.edu/PRS/petroIndex.html)
* [State Production and Historical Info](http://www.kgs.ku.edu/PRS/petro/state.html)
* [County Production](http://www.kgs.ku.edu/PRS/petro/interactive.html)
* [Production from Kansas Oil and Gas Fields](http://www.kgs.ku.edu/Magellan/Field/index.html)
* [Gas Storage Fields in Kansas](http://chasm.kgs.ku.edu/ords/oil.ogf4.GasStorage)
* [Production from Kansas Oil and Gas Leases](http://www.kgs.ku.edu/Magellan/Field/lease.html)
* [Kansas Oil and Gas Production by Operator](http://www.kgs.ku.edu/Magellan/Field/operators.html)
* [Master List of Oil and Gas Wells in Kansas](http://www.kgs.ku.edu/Magellan/Qualified/index.html)
* [Geology](http://www.kgs.ku.edu/General/geologyIndex.html)
* [Geophysics](http://www.kgs.ku.edu/Geophysics/esIndex.html)
## Usage
### Download data from [Kansas Master Ground-Water Well Inventory](http://hercules.kgs.ku.edu/geohydro/master_well/index.cfm)
There are two functions in the package which retrieve data from Kansas Master Ground-Water Well Inventory.
```{r water, eval = TRUE, warning=TRUE, error=TRUE, message=TRUE, cache=TRUE}
library(kgsr)
dt <- mwi("allen")
dt
# -----------------------------------------------------------------------------
# Ignoring unmatched file
# -----------------------------------------------------------------------------
dt <- mwi("Cowley")
dt
# -----------------------------------------------------------------------------
# Wrong county name
# -----------------------------------------------------------------------------
dt <- mwi("alen")
# -----------------------------------------------------------------------------
# Download with given township, range, range direction, and section (optional).
# -----------------------------------------------------------------------------
dt <- mwi_plss(township = "1", range = "1", range_dir = "W", section = "1", unmatched = TRUE)
dt
```
### Download data from [Master List of Oil and Gas Wells in Kansas](http://www.kgs.ku.edu/Magellan/Qualified/index.html)
```{r energy, eval = TRUE, warning=TRUE, error=TRUE, message=TRUE, cache=TRUE}
library(kgsr)
dt <- ogw(township = "1", range = "1")
dt
dt <- ogw(county = "allen", welltype = "OIL")
dt
```
## Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.