import_nrfa: Importing flow data from the National River Flow Archive...
In APEM-LTD/hetoolkit: Hydro-Ecology Toolkit
import_nrfa R Documentation
Importing flow data from the National River Flow Archive (NRFA)
Description
The import_nrfa function downloads mean daily flow data from the NRFA for a user-defined set of sites (gauging stations). Data can be optionally filtered by date.
Usage
import_nrfa(sites, start_date = "1985-01-01", end_data = Sys.Date(), tidyup = TRUE)
Arguments
sites
Vector of site (station) IDs to extract data for. NAs and blanks ("") are ignored
start_date
Start date for flow data extraction (YYYY-MM-DD format). Default = "1985-01-01".
end_date
End date for flow data extraction (YYYY-MM-DD format). Default = today's date.
tidyup
Whether or not csv files downloaded by the function to the users working directory should be deleted afterwards. Default = TRUE.
Details
The National River Flow Archive (NRFA; http://nrfa.ceh.ac.uk) is the main archive of river flow data for the United Kingdom, and contains data from over 1500 gauging stations. This function downloads flow data from the NRFA as a series of CSV files, one per site, and collates them into a single data set.
The function initially imports flow data for all dates and then filters out records that are before start_date or after end_date. If the data does not span the entire range of dates provided, additional records are created and the flow and quality values defined as NA on these dates.
A warning message is produced for every site that cannot be found on NRFA.
If a site ID is duplicated in the 'sites' argument, that site is only searched for once and a warning message is produced.
Value
A tibble containing daily flow data for the specified sites, with the following columns: flow-site_id, date, and flow (in m3/s). (The NRFA database does not contain information about the quality of the flow data.)
Examples
# Import data for selected sites and dates (and keep downloaded CSV files for inspection)
# import_nrfa(sites = c("1001", "2001"), start_date = "2000-01-01", end_date = "2019-12-31", tidyup = FALSE)
# Returns flow = NA if site exists but no data available for the specified date range
# import_nrfa(sites = c("1001"), start_date = "1900-01-01", end_date = "1900-01-05")
# Returns data only for sites that are present in NRFA; see warning messages for missing sites
# import_nrfa(sites = c("1001", "hello"), start_date = "2010-01-01", end_date = "2010-01-05")
APEM-LTD/hetoolkit documentation built on Feb. 8, 2025, 9:16 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| import_nrfa | R Documentation |
Importing flow data from the National River Flow Archive (NRFA)
Description
The import_nrfa function downloads mean daily flow data from the NRFA for a user-defined set of sites (gauging stations). Data can be optionally filtered by date.
Usage
import_nrfa(sites, start_date = "1985-01-01", end_data = Sys.Date(), tidyup = TRUE)
Arguments
sites |
Vector of site (station) IDs to extract data for. NAs and blanks ("") are ignored |
start_date |
Start date for flow data extraction (YYYY-MM-DD format). Default = "1985-01-01". |
end_date |
End date for flow data extraction (YYYY-MM-DD format). Default = today's date. |
tidyup |
Whether or not csv files downloaded by the function to the users working directory should be deleted afterwards. Default = TRUE. |
Details
The National River Flow Archive (NRFA; http://nrfa.ceh.ac.uk) is the main archive of river flow data for the United Kingdom, and contains data from over 1500 gauging stations. This function downloads flow data from the NRFA as a series of CSV files, one per site, and collates them into a single data set.
The function initially imports flow data for all dates and then filters out records that are before start_date or after end_date. If the data does not span the entire range of dates provided, additional records are created and the flow and quality values defined as NA on these dates.
A warning message is produced for every site that cannot be found on NRFA.
If a site ID is duplicated in the 'sites' argument, that site is only searched for once and a warning message is produced.
Value
A tibble containing daily flow data for the specified sites, with the following columns: flow-site_id, date, and flow (in m3/s). (The NRFA database does not contain information about the quality of the flow data.)
Examples
# Import data for selected sites and dates (and keep downloaded CSV files for inspection)
# import_nrfa(sites = c("1001", "2001"), start_date = "2000-01-01", end_date = "2019-12-31", tidyup = FALSE)
# Returns flow = NA if site exists but no data available for the specified date range
# import_nrfa(sites = c("1001"), start_date = "1900-01-01", end_date = "1900-01-05")
# Returns data only for sites that are present in NRFA; see warning messages for missing sites
# import_nrfa(sites = c("1001", "hello"), start_date = "2010-01-01", end_date = "2010-01-05")
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.