Prepare new release

.github/workflows/R-CMD-check.yaml

@@ -22,9 +22,9 @@ jobs:
       fail-fast: false
       matrix:
         config:
-          - {os: macOS-latest, r: 'release'}      
-          - {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}      
-          - {os: windows-latest, r: 'devel'}          
+          - {os: macOS-latest, r: 'release'}
+          - {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
+          - {os: windows-latest, r: 'devel'}
           - {os: windows-latest, r: 'oldrel'}
           - {os: windows-latest, r: 'release'}
 
@@ -35,18 +35,23 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      
-      - uses: r-lib/actions/setup-r@master
+
+      - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
-          
-      - uses: r-lib/actions/setup-pandoc@master
-      
-      - name: Install spatial dependencies
-        if: runner.os != 'Windows'
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - name: Install spatial dependencies on macOS
+        if: runner.os == 'macOS'
         run: |
           brew install gdal proj
-
+
+      - name: Install spatial dependencies on Linux
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get install gdal-bin
+
       - name: Query dependencies
         run: |
           install.packages('remotes')
@@ -55,7 +60,7 @@ jobs:
 
       - name: Cache R packages
         if: runner.os != 'Windows'
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         with:
           path: ${{ env.R_LIBS_USER }}
           key: ${{ runner.os }}-r-${{ matrix.config.r }}-3-${{ hashFiles('depends.Rds') }}
@@ -81,7 +86,7 @@ jobs:
 
       - name: Upload check results
         if: failure()
-        uses: actions/upload-artifact@master
+        uses: actions/upload-artifact@v3
         with:
           name: ${{ runner.os }}-r${{ matrix.config.r }}-results
           path: check

.github/workflows/R-CMD-check2.yaml

@@ -29,16 +29,16 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: r-lib/actions/setup-pandoc@v1
+      - uses: r-lib/actions/setup-pandoc@v2
 
-      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
           http-user-agent: ${{ matrix.config.http-user-agent }}
           use-public-rspm: true
 
-      - uses: r-lib/actions/setup-r-dependencies@v1
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
           extra-packages: rcmdcheck
 
-      - uses: r-lib/actions/check-r-package@v1
+      - uses: r-lib/actions/check-r-package@v2

.github/workflows/pkgdown.yaml

@@ -15,13 +15,13 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: r-lib/actions/setup-r@master
+      - uses: r-lib/actions/setup-r@v2
+
+      - uses: r-lib/actions/setup-pandoc@v2
 
-      - uses: r-lib/actions/setup-pandoc@master
-
       - name: Install spatial dependencies
         run: |
-          rm '/usr/local/bin/gfortran'
+          #rm '/usr/local/bin/gfortran'
           brew install gdal proj
 
       - name: Query dependencies

.github/workflows/pr-commands.yaml

@@ -11,10 +11,10 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - uses: actions/checkout@v2
-      - uses: r-lib/actions/pr-fetch@master
+      - uses: r-lib/actions/pr-fetch@v2
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: r-lib/actions/setup-r@master
+      - uses: r-lib/actions/setup-r@v2
       - name: Install dependencies
         run: Rscript -e 'install.packages(c("remotes", "roxygen2"))' -e 'remotes::install_deps(dependencies = TRUE)'
       - name: Document
@@ -23,7 +23,7 @@ jobs:
         run: |
           git add man/\* NAMESPACE
           git commit -m 'Document'
-      - uses: r-lib/actions/pr-push@master
+      - uses: r-lib/actions/pr-push@v2
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
   style:
@@ -34,10 +34,10 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - uses: actions/checkout@v2
-      - uses: r-lib/actions/pr-fetch@master
+      - uses: r-lib/actions/pr-fetch@v2
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: r-lib/actions/setup-r@master
+      - uses: r-lib/actions/setup-r@v2
       - name: Install dependencies
         run: Rscript -e 'install.packages("styler")'
       - name: Style
@@ -46,6 +46,6 @@ jobs:
         run: |
           git add \*.R
           git commit -m 'Style'
-      - uses: r-lib/actions/pr-push@master
+      - uses: r-lib/actions/pr-push@v2
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test-coverage.yaml

@@ -18,9 +18,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: r-lib/actions/setup-r@master
+      - uses: r-lib/actions/setup-r@v2
 
-      - uses: r-lib/actions/setup-pandoc@master
+      - uses: r-lib/actions/setup-pandoc@v2
 
       - name: Query dependencies
         run: |
@@ -30,7 +30,7 @@ jobs:
         shell: Rscript {0}
 
       - name: Cache R packages
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         with:
           path: ${{ env.R_LIBS_USER }}
           key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: kwb.dwd
 Title: Access Information from Deutscher Wetterdienst (DWD)
-Version: 0.2.0
+Version: 0.3.0
 Authors@R: 
     c(person(given = "Hauke",
              family = "Sonnenberg",
@@ -32,7 +32,7 @@ License: MIT + file LICENSE
 URL: https://github.com/KWB-R/kwb.dwd
 BugReports: https://github.com/KWB-R/kwb.dwd/issues
 Depends: 
-    R (>= 3.0)
+    R (>= 3.5.0)
 Imports: 
     archive,
     bitops (>= 1.0.6),
@@ -55,7 +55,11 @@ VignetteBuilder:
     knitr
 Remotes:
     github::kwb-r/kwb.utils
+Additional_repositories:
+   https://packagemanager.posit.co/cran/2023-09-20/
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.2.1
+LazyDataCompression: bzip2
+RoxygenNote: 7.2.3
+Roxygen: list(markdown = TRUE)
 Config/testthat/edition: 3

NAMESPACE

@@ -1,11 +1,11 @@
 # Generated by roxygen2: do not edit by hand
 
 export(calculate_masked_grid_stats)
-export(check_or_download_shapes_germany)
 export(convert_bin_to_raster_file)
 export(coordinates_to_EPSG_4326)
 export(crop_radolan_radial)
 export(download_radolan)
+export(download_shapes_germany)
 export(extract_radolan_zip_files)
 export(get_berlin_dwd_mask)
 export(get_dwd_urls_metadata)
@@ -14,6 +14,7 @@ export(get_radolan_extension)
 export(get_radolan_projection_string)
 export(get_radolan_urls)
 export(get_shapes_of_germany)
+export(list_extracted_radolan_files)
 export(list_url)
 export(load_potential_evaporation_berlin)
 export(load_potential_evaporation_berlin_2)
@@ -23,8 +24,10 @@ 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)
 export(unzip_asc_gz_file)
 export(write_raster_to_file)
 importFrom(RCurl,curlOptions)
@@ -39,9 +42,11 @@ importFrom(kwb.utils,callWith)
 importFrom(kwb.utils,catAndRun)
 importFrom(kwb.utils,catIf)
 importFrom(kwb.utils,clearConsole)
+importFrom(kwb.utils,commonNames)
 importFrom(kwb.utils,createDirectory)
 importFrom(kwb.utils,expandGrid)
 importFrom(kwb.utils,extractSubstring)
+importFrom(kwb.utils,fileExtension)
 importFrom(kwb.utils,getAttribute)
 importFrom(kwb.utils,left)
 importFrom(kwb.utils,listToDepth)
@@ -51,6 +56,7 @@ importFrom(kwb.utils,pasteColumns)
 importFrom(kwb.utils,removeColumns)
 importFrom(kwb.utils,removeExtension)
 importFrom(kwb.utils,replaceFileExtension)
+importFrom(kwb.utils,resetRowNames)
 importFrom(kwb.utils,resolve)
 importFrom(kwb.utils,right)
 importFrom(kwb.utils,safePath)
@@ -65,6 +71,7 @@ importFrom(lubridate,month)
 importFrom(lubridate,rollback)
 importFrom(lubridate,ymd)
 importFrom(magrittr,"%>%")
+importFrom(raster,`crs<-`)
 importFrom(raster,cellStats)
 importFrom(raster,crop)
 importFrom(raster,extent)
@@ -73,9 +80,12 @@ importFrom(raster,raster)
 importFrom(raster,stack)
 importFrom(raster,writeRaster)
 importFrom(rgdal,readOGR)
+importFrom(sf,as_Spatial)
 importFrom(sf,st_as_sf)
 importFrom(sf,st_buffer)
+importFrom(sf,st_read)
 importFrom(sf,st_transform)
+importFrom(sf,st_zm)
 importFrom(sp,CRS)
 importFrom(stats,sd)
 importFrom(stats,setNames)

NEWS.md

@@ -1,9 +1,106 @@
+# 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
+since 2023-10-16, see [here](https://cran.r-project.org/web/packages/rgdal/index.html)).
+
 # kwb.dwd 0.2.0 (2022-09-20)
 
 * 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 "..."