Skip to content

Commit fd083f0

Browse files
committed
update README
1 parent bb8221f commit fd083f0

File tree

4 files changed

+23
-31
lines changed

4 files changed

+23
-31
lines changed

README.Rmd

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,6 @@ knitr::opts_chunk$set(
2727
<!-- badges: end -->
2828

2929

30-
## Project Status
31-
32-
This package is maintained by the Data Science Partnerships Program in the [British Columbia Ministry of Citizens' Services](https://www2.gov.bc.ca/gov/content/governments/organizational-structure/ministries-organizations/ministries/citizens-services).
33-
34-
3530
## What does `tidyhydat` do?
3631

3732
- Provides functions (`hy_*`) that access hydrometric data from the HYDAT database, a national archive of Canadian hydrometric data and return tidy data.

README.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,6 @@ checks](https://cranchecks.info/badges/worst/tidyhydat)](https://cran.r-project.
2222
[![DOI](https://zenodo.org/badge/100978874.svg)](https://zenodo.org/badge/latestdoi/100978874)
2323
<!-- badges: end -->
2424

25-
## Project Status
26-
27-
This package is maintained by the Data Science Partnerships Program in
28-
the [British Columbia Ministry of Citizens’
29-
Services](https://www2.gov.bc.ca/gov/content/governments/organizational-structure/ministries-organizations/ministries/citizens-services).
30-
3125
## What does `tidyhydat` do?
3226

3327
- Provides functions (`hy_*`) that access hydrometric data from the
@@ -92,22 +86,23 @@ the same conventions discussed above. Using `realtime_dd()` we can
9286
easily select specific stations by supplying a station of interest:
9387

9488
realtime_dd(station_number = "08MF005")
95-
#> Queried on: 2022-03-16 22:48:40 (UTC)
96-
#> Date range: 2022-02-14 to 2022-03-16
97-
#> # A tibble: 17,608 x 8
98-
#> STATION_NUMBER PROV_TERR_STATE_LOC Date Parameter Value Grade
99-
#> <chr> <chr> <dttm> <chr> <dbl> <chr>
100-
#> 1 08MF005 BC 2022-02-14 08:00:00 Flow 1080 <NA>
101-
#> 2 08MF005 BC 2022-02-14 08:05:00 Flow 1080 <NA>
102-
#> 3 08MF005 BC 2022-02-14 08:10:00 Flow 1070 <NA>
103-
#> 4 08MF005 BC 2022-02-14 08:15:00 Flow 1070 <NA>
104-
#> 5 08MF005 BC 2022-02-14 08:20:00 Flow 1070 <NA>
105-
#> 6 08MF005 BC 2022-02-14 08:25:00 Flow 1070 <NA>
106-
#> 7 08MF005 BC 2022-02-14 08:30:00 Flow 1070 <NA>
107-
#> 8 08MF005 BC 2022-02-14 08:35:00 Flow 1080 <NA>
108-
#> 9 08MF005 BC 2022-02-14 08:40:00 Flow 1070 <NA>
109-
#> 10 08MF005 BC 2022-02-14 08:45:00 Flow 1070 <NA>
110-
#> # ... with 17,598 more rows, and 2 more variables: Symbol <chr>, Code <chr>
89+
#> Queried on: 2022-10-15 15:31:53 (UTC)
90+
#> Date range: 2022-09-14 to 2022-10-15
91+
#> # A tibble: 18,006 × 8
92+
#> STATION_NUMBER PROV_TE…¹ Date Param…² Value Grade Symbol Code
93+
#> <chr> <chr> <dttm> <chr> <dbl> <chr> <chr> <chr>
94+
#> 1 08MF005 BC 2022-09-14 08:00:00 Flow 2010 <NA> <NA> 1
95+
#> 2 08MF005 BC 2022-09-14 08:05:00 Flow 2010 <NA> <NA> 1
96+
#> 3 08MF005 BC 2022-09-14 08:10:00 Flow 2000 <NA> <NA> 1
97+
#> 4 08MF005 BC 2022-09-14 08:15:00 Flow 2010 <NA> <NA> 1
98+
#> 5 08MF005 BC 2022-09-14 08:20:00 Flow 2000 <NA> <NA> 1
99+
#> 6 08MF005 BC 2022-09-14 08:25:00 Flow 2000 <NA> <NA> 1
100+
#> 7 08MF005 BC 2022-09-14 08:30:00 Flow 2000 <NA> <NA> 1
101+
#> 8 08MF005 BC 2022-09-14 08:35:00 Flow 2010 <NA> <NA> 1
102+
#> 9 08MF005 BC 2022-09-14 08:40:00 Flow 2010 <NA> <NA> 1
103+
#> 10 08MF005 BC 2022-09-14 08:45:00 Flow 2000 <NA> <NA> 1
104+
#> # … with 17,996 more rows, and abbreviated variable names ¹​PROV_TERR_STATE_LOC,
105+
#> # ²​Parameter
111106

112107
### Plotting
113108

@@ -149,10 +144,12 @@ By participating in this project you agree to abide by its terms.
149144
Get citation information for `tidyhydat` in R by running:
150145

151146

152-
Albers S (2017). "tidyhydat: Extract and Tidy Canadian Hydrometric
153-
Data." _The Journal of Open Source Software_, *2*(20). doi:
154-
10.21105/joss.00511 (URL: https://doi.org/10.21105/joss.00511), <URL:
155-
http://dx.doi.org/10.21105/joss.00511>.
147+
To cite package 'tidyhydat' in publications use:
148+
149+
Albers S (2017). "tidyhydat: Extract and Tidy Canadian Hydrometric
150+
Data." _The Journal of Open Source Software_, *2*(20).
151+
doi:10.21105/joss.00511 <https://doi.org/10.21105/joss.00511>,
152+
<http://dx.doi.org/10.21105/joss.00511>.
156153

157154
A BibTeX entry for LaTeX users is
158155

40.8 KB
Loading
73.9 KB
Loading

0 commit comments

Comments
 (0)