Merge branch 'dev' of https://github.com/KWB-R/kwb.dwd into dev

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: kwb.dwd
 Title: Access Information from Deutscher Wetterdienst (DWD)
-Version: 0.2.1
+Version: 0.3.0
 Authors@R: 
     c(person(given = "Hauke",
              family = "Sonnenberg",

NAMESPACE

@@ -24,6 +24,7 @@ export(radolan_raw_to_raster)
 export(read_asc_gz_file)
 export(read_binary_radolan_file)
 export(read_daily_data_over_shape)
+export(read_data_over_shape)
 export(read_monthly_data_over_shape)
 export(read_relevant_years_radolan)
 export(temp_dir)

NEWS.md

@@ -1,3 +1,95 @@
+# kwb.dwd 0.3.0 (2023-05-23)
+
+* update/improve/fix GitHub actions workflow files
+* depend on R >= 3.5.0 (Required by R CMD check)
+* use Markdown syntax in roxygen comments
+* update dataset `dwd_files`
+* add new datasets
+    - `shapes_germany_0`, 
+    - `shapes_germany_1`,
+    - `shapes_germany_2`
+* add new functions (exported)
+    - `list_extracted_radolan_files`
+* export functions that were private before 
+    - `temp_dir`
+* add new functions (not exported)
+    - `assert_all_ending_with`
+    - `check_binary_radolan_files` 
+    - `configure_radolan`
+    - `consider_flags`
+    - `contains_file`
+    - `copy_file`
+    - `download_and_extract_radolan` 
+    - `download_and_extract_radolan_url` 
+    - `download_dir`
+    - `download_into_folder_structure` 
+    - `ftp_path_radolan`
+    - `ftp_path_radolan_all`
+    - `get_full_extension`
+    - `get_radolan_format_description` 
+    - `get_radolan_header_patterns`
+    - `get_radolan_metadata`
+    - `get_radolan_metadata_from_header` 
+    - `get_radolan_timestamps` 
+    - `get_radolan_timestamps_from_filenames` 
+    - `get_radolan_timestamps_from_headers` 
+    - `get_regional_stats_from_radolan_asc_files` 
+    - `get_regional_stats_from_radolan_bin_files` 
+    - `get_regional_stats_from_radolan_files` 
+    - `get_relative_path`
+    - `list_grids_germany`
+    - `month_range_pattern`
+    - `on_windows`
+    - `open_for_reading_in_binary_mode`
+    - `read_asc_file`
+    - `read_hourly_radolan_historical_bin_for_region`
+    - `remove_left`
+    - `remove_protocol`
+    - `remove_right`
+    - `split_radolan_header`
+    - `unzip_tar_file`
+    - `unzip_tar_gz_file`
+    - `unzip_zip_file`
+    - `url_to_relative_path`
+* modify functions
+    - `check_or_download_shapes_germany`: add arguments "url", "timeout", report 
+       about "timeout" error, rename to `download_shapes_germany` 
+    - `default_projection_file`: add argument "quiet"
+    - `download_if_not_there`: add arguments "target_dir", "mode", "timeout",
+      rename to `download`
+    - `extract_radolan_zip_files`: refactor
+    - `filter_shapes`: use accessor function, check that one row is selected
+    - `get_berlin_dwd_mask`: simplify
+    - `get_shapes_of_germany`: add argument "use_sf", return shapes that are 
+       provided as datasets in the package
+    - `last_month_as_yyyymm`: rename to "last_month", add argument "format"
+    - `list_zip_files`: refactor
+    - `month_sequence`: add argument "simple"
+    - `provide_projection_file`: refactor
+    - `raster_stats`: use raster`::getValues
+    - `read_binary_radolan_file`: add argument "consider_flags"
+    - `read_binary_radolan_header`: add argument "dbg"
+    - `read_monthly_data_over_shape`: add argument "quiet", "shape", "use_sf"
+    - `read_shape_file`: merge two functions (function was defined twice!)
+    - `select_shapes`: improve output
+    - `temp_dir`: rename arguments (remove dot) and export
+    - `transform_coords`: ?
+* remove functions
+    - `assert_ending_gz` (use `assert_all_ending_with`)
+    - `extract_metadata_from_files_daily` (use `extract_metadata_from_files`)
+    - `extract_metadata_from_files_monthly` (use `extract_metadata_from_files`)
+    - `extract_yyyymm` (integrated where it was used)
+    - `filter_by_extension_asc_gz` (use `filter_by_extension`)
+    - `filter_by_extension_tgz` (use `filter_by_extension`)
+    - `frequency_prefix` (integrated where it was used)
+    - `ftp_path_daily_grids` (use `ftp_path_grids_germany`)
+    - `ftp_path_monthly_grids` (use `ftp_path_grids_germany`)
+    - `list_daily_grids_germany_tgz` (use `list_grids_germany`)
+    - `list_monthly_grids_germany_asc_gz` (use `list_grids_germany`)
+    - `main_columns_first` (integrated where it was used)
+    - `month_sequence_simple` (use `month_sequence_simple`)
+    - `url_projection`
+
 # kwb.dwd 0.2.1 (2024-04-08)
 
 * Install `rgdal` dependency from CRAN`s GitHub account (as it has been archived
@@ -8,7 +100,7 @@ since 2023-10-16, see [here](https://cran.r-project.org/web/packages/rgdal/index
 * add contributors Michael Rustler, Lukas Guericke
 * use GitHub actions instead of Travis and Appveyor
 * add tests
-* update dataset [dwd_files](../reference/dwd_files.html)
+* update dataset `dwd_files`
 * modify functions
     - `get_radolan_url()`: add arg "ftp_root"
     - `get_radolan_urls()`: add args "..."

R/download_grids_germany.R

@@ -0,0 +1,17 @@
+download_grids_germany <- function(resolution, variable, from, to, quiet = FALSE)
+{
+  if (resolution == "daily") {
+
+    # Download and extract .tgz files from DWD server
+    download_daily_grids_germany(variable, from, to, quiet = quiet)
+
+  } else if (resolution == "monthly") {
+
+    # Download files from DWD server
+    download_monthly_grids_germany(variable, from, to, quiet = quiet)
+
+  } else {
+
+    clean_stop("resolution must be one of 'daily', 'monthly'.")
+  }
+}

R/get_radolan_projection_string.R

@@ -11,6 +11,9 @@
 #'  * [get_radolan_extension].
 get_radolan_projection_string <- function()
 {
+  # TODO: Is this the same?
+  # readLines(default_projection_file())
+
   to_projection_string(
     parameters = list(
       proj = "stere",

R/read_asc_gz_file.R

@@ -27,25 +27,22 @@ read_asc_gz_file <- function(file, url = NULL)
 
   #dir(target_dir)
 
-  # Provide a copy of the projection file in the download folder
-  provide_projection_file(grid_file)
-
-  raster::raster(grid_file)
+  # Read the .asc file into a raster object (with appropriate projection)
+  read_asc_file(grid_file)
 }
 
 # read_asc_file ----------------------------------------------------------------
 
 #' Read Raster Data from .ASC File
 #'
 #' @param file path to .asc file
-#' @param projection projection string used in Radolan data
+#' @param projection projection string used in Radolan data. Currently not used!
 #' @param dbg logical indicating whether to show debug messages
 #' @importFrom kwb.utils catAndRun
 #' @importFrom raster `crs<-` raster
 read_asc_file <- function(
     file,
     projection = get_radolan_projection_string(),
-    #projection = readLines(default_projection_file()),
     dbg = TRUE
 )
 {