kiwisR

<!-- badges: end -->

Overview

A wrapper for querying KISTERS WISKI databases via the KiWIS API. Users can toggle between various databases by specifying the hub argument. Currently, the default hubs are:

• kisters : KISTERS KiWIS Example Server
• swmc : Ontario Surface Water Monitoring Centre
• quinte : Quinte Conservation Authority

All data is returned as tidy tibbles.

Installation

You can install kiwisR from CRAN:

r install.packages('kiwisR')

To install the development version of kiwisR you first need to install devtools.

r if(!requireNamespace("devtools")) install.packages("devtools") devtools::install_github('rywhale/kiwisR')

Then load the package with

r library(kiwisR)

Usage

Get Station Information

By default, ki_station_list() returns a tibble containing information for all available stations for the selected hub.

``` r

With swmc as the hub

kistationlist(hub = 'swmc')

> # A tibble: 3,941 × 5

> stationname stationno stationid stationlatitude station_longitude

>

> 1 A SNOW TEMPLATE SNOW-WLF-… 952125 NA NA

> 2 AA SNOW TEMPLATE SNOW-WLF-… 954599 NA NA

> 3 AARON PP SNOW-MNR-… 1346534 49.8 -92.6

> 4 ABERDEEN CLIM-MSC-… 121939 45.5 -98.4

> 5 ABITIBI CANYON ZZSNOW-OP… 148200 49.9 -81.6

> 6 ABITIBI LAKE CLIM-MNR-… 121135 48.7 -80.1

> 7 ABITIBI RIVER AT AB… HYDAT-04M… 136328 49.9 -81.6

> 8 ABITIBI RIVER AT IR… HYDAT-04M… 136304 48.8 -80.7

> 9 ABITIBI RIVER AT IS… HYDAT-04M… 136324 49.6 -81.4

> 10 Abitibi River at On… WSC-04ME0… 146775 50.6 -81.4

> # ℹ 3,931 more rows

```

Get Time Series Information

You can use the station_id column returned using ki_station_list() to figure out which time series are available for a given station.

One Station

``` r

Single station_id

availablets <- kitimeserieslist( hub = 'swmc', stationid = "144659" )

available_ts

> # A tibble: 223 × 6

> stationname stationid tsid tsname from to

>

> 1 Jackson Cre… 144659 9489… Precip… 2007-06-18 20:15:00 2024-10-11 10:15:00

> 2 Jackson Cre… 144659 1143… Precip… 2007-07-01 05:00:00 2024-11-01 05:00:00

> 3 Jackson Cre… 144659 1143… Precip… 2007-06-18 05:00:00 2024-10-12 05:00:00

> 4 Jackson Cre… 144659 9489… TAir.1… 2007-06-18 20:15:00 2024-10-11 10:15:00

> 5 Jackson Cre… 144659 9489… TAir.D… 2007-06-18 05:00:00 2024-10-10 05:00:00

> 6 Jackson Cre… 144659 9489… TAir.D… 2007-06-18 05:00:00 2024-10-10 05:00:00

> 7 Jackson Cre… 144659 1129… TAir.6… 2007-06-19 00:00:00 2024-10-11 06:00:00

> 8 Jackson Cre… 144659 1326… TAir.D… 2007-06-18 05:00:00 2024-10-12 05:00:00

> 9 Jackson Cre… 144659 1326… TAir.D… 2007-06-18 05:00:00 2024-10-12 05:00:00

> 10 Jackson Cre… 144659 9490… TWater… 2007-06-18 05:00:00 2024-10-10 05:00:00

> # ℹ 213 more rows

```

Multiple Stations

If you provide a vector to station_id, the returned tibble will have all the available time series from all stations. They can be differentiated using the station_name column.

``` r

Vector of station_ids

mystationids <- c("144659", "144342")

availablets <- kitimeserieslist( hub = 'swmc', stationid = mystationids )

available_ts

> # A tibble: 331 × 6

> stationname stationid tsid tsname from to

>

> 1 Oshawa Cree… 144342 1331… Precip… 2023-07-05 05:00:00 2024-08-27 00:00:00

> 2 Oshawa Cree… 144342 9455… TWater… 2011-07-25 05:00:00 2024-10-10 05:00:00

> 3 Oshawa Cree… 144342 9455… TWater… 2011-07-25 05:00:00 2024-10-10 05:00:00

> 4 Oshawa Cree… 144342 9456… LVL.Mo… 2001-12-01 05:00:00 2021-12-01 05:00:00

> 5 Oshawa Cree… 144342 9456… LVL.Ye… 2002-01-01 05:00:00 2021-01-01 05:00:00

> 6 Oshawa Cree… 144342 1235… WWP.St… 1985-01-01 05:00:00 2025-01-01 05:00:00

> 7 Oshawa Cree… 144342 1243… WWP.St… 1985-01-01 05:00:00 2025-01-01 05:00:00

> 8 Oshawa Cree… 144342 9456… Q.DayM… 1986-09-01 05:00:00 2024-10-10 05:00:00

> 9 Oshawa Cree… 144342 9456… Q.Year… 1986-01-01 05:00:00 2023-01-01 05:00:00

> 10 Oshawa Cree… 144342 1239… WWP.St… 1985-01-01 05:00:00 2025-01-01 05:00:00

> # ℹ 321 more rows

```

Get Time Series Values

You can now use the ts_id column in the tibble produced by ki_timeseries_list() to query values for chosen time series.

By default this will return values for the past 24 hours. You can specify the dates you’re interested in by setting start_date and end_date. These should be set as date strings with the format ‘YYYY-mm-dd’.

You can pass either a single or multiple ts_id(s).

One Time Series

``` r

Past 24 hours

myvalues <- kitimeseriesvalues( hub = 'swmc', tsid = '966435042' )

> No start or end date provided, trying to return data for past 24 hours

my_values

> # A tibble: 405 × 7

> Timestamp Value tsname tsid Units stationname stationid

>

> 1 2024-10-10 00:00:00 23.1 LVL.1.O 966435042 m Attawapiskat Ri… 146273

> 2 2024-10-10 00:05:00 23.1 LVL.1.O 966435042 m Attawapiskat Ri… 146273

> 3 2024-10-10 00:10:00 23.1 LVL.1.O 966435042 m Attawapiskat Ri… 146273

> 4 2024-10-10 00:15:00 23.1 LVL.1.O 966435042 m Attawapiskat Ri… 146273

> 5 2024-10-10 00:20:00 23.1 LVL.1.O 966435042 m Attawapiskat Ri… 146273

> 6 2024-10-10 00:25:00 23.1 LVL.1.O 966435042 m Attawapiskat Ri… 146273

> 7 2024-10-10 00:30:00 23.1 LVL.1.O 966435042 m Attawapiskat Ri… 146273

> 8 2024-10-10 00:35:00 23.1 LVL.1.O 966435042 m Attawapiskat Ri… 146273

> 9 2024-10-10 00:40:00 23.1 LVL.1.O 966435042 m Attawapiskat Ri… 146273

> 10 2024-10-10 00:45:00 23.1 LVL.1.O 966435042 m Attawapiskat Ri… 146273

> # ℹ 395 more rows

```

Multiple Time Series

``` r

Specified date, multiple time series

mytsids <- c("1125831042","908195042") myvalues <- kitimeseriesvalues( hub = 'swmc', tsid = mytsids, startdate = "2015-08-28", enddate = "2018-09-13" )

my_values

> # A tibble: 1,264 × 7

> Timestamp Value tsname tsid Units stationname stationid

>

> 1 2015-09-06 05:00:00 0.19 Q.DayBaseflow 112583… cumec Chippewa Cr… 140764

> 2 2015-09-17 05:00:00 0.18 Q.DayBaseflow 112583… cumec Chippewa Cr… 140764

> 3 2015-09-26 05:00:00 0.19 Q.DayBaseflow 112583… cumec Chippewa Cr… 140764

> 4 2015-09-27 05:00:00 0.19 Q.DayBaseflow 112583… cumec Chippewa Cr… 140764

> 5 2015-09-28 05:00:00 0.19 Q.DayBaseflow 112583… cumec Chippewa Cr… 140764

> 6 2015-10-03 05:00:00 0.21 Q.DayBaseflow 112583… cumec Chippewa Cr… 140764

> 7 2015-10-08 05:00:00 0.22 Q.DayBaseflow 112583… cumec Chippewa Cr… 140764

> 8 2015-10-12 05:00:00 0.24 Q.DayBaseflow 112583… cumec Chippewa Cr… 140764

> 9 2015-10-24 05:00:00 0.41 Q.DayBaseflow 112583… cumec Chippewa Cr… 140764

> 10 2015-11-11 05:00:00 0.42 Q.DayBaseflow 112583… cumec Chippewa Cr… 140764

> # ℹ 1,254 more rows

```

Using Other Hubs

You can use this package for a KiWIS hub not included in this list by feeding the location of the API service to the hub argument.

For instance: If your URL looks like

http://kiwis.kisters.de/KiWIS/KiWIS?datasource=0&service=kisters&type=queryServices&request=getrequestinfo

specify the hub argument with

http://kiwis.kisters.de/KiWIS/KiWIS?

If you’d like to have a hub added to the defaults, please Submit an Issue

Contributing

See here if you’d like to contribute.