From d3b5851d3d12836b32d8f8d4ba57d601426ae304 Mon Sep 17 00:00:00 2001 From: hsonne Date: Tue, 23 May 2023 22:02:23 +0200 Subject: [PATCH] Link to related functions unsing script The script identifies what exported functions are related to each other and modifies the source files by adding a seealso section to the Roxygen header. --- R/check_or_download_shapes_germany.R | 4 ++++ R/convert_bin_to_raster_file.R | 4 ++++ R/crop_radolan_radial.R | 5 +++++ R/download_radolan.R | 5 +++++ R/extract_radolan_zip_files.R | 2 ++ R/get_dwd_urls_metadata.R | 3 +++ R/get_example_grid_germany.R | 2 ++ R/get_radolan_projection_string.R | 3 +++ R/get_radolan_urls.R | 4 ++++ R/get_shapes_of_germany.R | 3 +++ R/list_extracted_radolan_files.R | 2 ++ R/list_url.R | 2 ++ R/load_monthly_data_for_berlin.R | 12 ++++++++++++ R/load_monthly_variable_for_region.R | 4 ++++ R/radolan_raw_to_raster.R | 5 +++++ R/read_asc_gz_file.R | 3 +++ R/read_binary_radolan_file.R | 6 ++++++ R/read_daily_data_over_shape.R | 5 +++++ R/read_monthly_data_over_shape.R | 5 +++++ R/read_relevant_years_radolan.R | 2 ++ R/unzip.R | 5 +++++ man/calculate_masked_grid_stats.Rd | 5 +++++ man/check_or_download_shapes_germany.Rd | 7 +++++++ man/convert_bin_to_raster_file.Rd | 5 +++++ man/crop_radolan_radial.Rd | 8 ++++++++ man/download_radolan.Rd | 8 ++++++++ man/extract_radolan_zip_files.Rd | 5 +++++ man/get_berlin_dwd_mask.Rd | 5 +++++ man/get_dwd_urls_metadata.Rd | 6 ++++++ man/get_example_grid_germany.Rd | 5 +++++ man/get_radolan_extension.Rd | 6 ++++++ man/get_radolan_projection_string.Rd | 6 ++++++ man/get_radolan_urls.Rd | 7 +++++++ man/get_shapes_of_germany.Rd | 6 ++++++ man/list_extracted_radolan_files.Rd | 5 +++++ man/list_url.Rd | 5 +++++ man/load_potential_evaporation_berlin.Rd | 7 +++++++ man/load_potential_evaporation_berlin_2.Rd | 7 +++++++ man/load_precipitation_berlin.Rd | 7 +++++++ man/radolan_raw_to_raster.Rd | 8 ++++++++ man/read_asc_gz_file.Rd | 6 ++++++ man/read_binary_radolan_file.Rd | 6 ++++++ man/read_daily_data_over_shape.Rd | 8 ++++++++ man/read_monthly_data_over_shape.Rd | 8 ++++++++ man/read_relevant_years_radolan.Rd | 5 +++++ man/unzip_asc_gz_file.Rd | 8 ++++++++ man/write_raster_to_file.Rd | 5 +++++ 47 files changed, 250 insertions(+) diff --git a/R/check_or_download_shapes_germany.R b/R/check_or_download_shapes_germany.R index 77a584f5..b3168f32 100644 --- a/R/check_or_download_shapes_germany.R +++ b/R/check_or_download_shapes_germany.R @@ -24,6 +24,10 @@ if (FALSE) #' @param timeout timeout in seconds #' @return path to folder containing shape files #' @export +#' @seealso +#' * [get_shapes_of_germany], +#' * [get_example_grid_germany], +#' * [download_radolan]. check_or_download_shapes_germany <- function( url = "https://geodata.ucdavis.edu/gadm/gadm4.0/shp/gadm40_DEU_shp.zip", quiet = FALSE, diff --git a/R/convert_bin_to_raster_file.R b/R/convert_bin_to_raster_file.R index ba65a396..fa5ac4ba 100644 --- a/R/convert_bin_to_raster_file.R +++ b/R/convert_bin_to_raster_file.R @@ -9,6 +9,8 @@ #' @param dbg if `TRUE`, debug messages are shown #' @export #' @importFrom kwb.utils createDirectory +#' @seealso +#' * [write_raster_to_file]. convert_bin_to_raster_file <- function(bin_file, target_dir = NULL, dbg = TRUE) { stopifnot(is.character(bin_file)) @@ -60,6 +62,8 @@ convert_bin_to_raster_file <- function(bin_file, target_dir = NULL, dbg = TRUE) #' @export #' #' @importFrom raster writeRaster +#' @seealso +#' * [convert_bin_to_raster_file]. write_raster_to_file <- function(rb, file, dbg = TRUE) { kwb.utils::catAndRun( diff --git a/R/crop_radolan_radial.R b/R/crop_radolan_radial.R index 89e4ea62..140cf91f 100644 --- a/R/crop_radolan_radial.R +++ b/R/crop_radolan_radial.R @@ -13,6 +13,11 @@ #' @importFrom sf st_buffer st_transform #' @importFrom raster cellStats crop #' @importFrom lubridate ymd +#' @seealso +#' * [get_radolan_urls], +#' * [extract_radolan_zip_files], +#' * [radolan_raw_to_raster], +#' * [download_radolan]. crop_radolan_radial <- function( radolan, longitude, latitude, radius = 10, as_data_frame = TRUE ) diff --git a/R/download_radolan.R b/R/download_radolan.R index 6f62a4a9..8a6a3d03 100644 --- a/R/download_radolan.R +++ b/R/download_radolan.R @@ -14,6 +14,11 @@ #' @export #' @examples #' \dontrun{download_radolan(resolution = "daily")} +#' @seealso +#' * [get_radolan_urls], +#' * [extract_radolan_zip_files], +#' * [radolan_raw_to_raster], +#' * [list_extracted_radolan_files]. download_radolan <- function(resolution = "daily", export_dir = "data", ...) { if (! resolution %in% c("daily", "hourly")) { diff --git a/R/extract_radolan_zip_files.R b/R/extract_radolan_zip_files.R index 8306c09a..0add0c63 100644 --- a/R/extract_radolan_zip_files.R +++ b/R/extract_radolan_zip_files.R @@ -10,6 +10,8 @@ #' #' @export #' @importFrom kwb.utils createDirectory +#' @seealso +#' * [list_extracted_radolan_files]. extract_radolan_zip_files <- function(radolan_dir) { #radolan_dir = download_dir("dwd") diff --git a/R/get_dwd_urls_metadata.R b/R/get_dwd_urls_metadata.R index 42368533..87dabc1e 100644 --- a/R/get_dwd_urls_metadata.R +++ b/R/get_dwd_urls_metadata.R @@ -9,6 +9,9 @@ #' @export #' @importFrom stats setNames #' @importFrom kwb.utils pasteColumns +#' @seealso +#' * [get_radolan_urls], +#' * [get_berlin_dwd_mask]. get_dwd_urls_metadata <- function() { # Note: category "solar" is not considered diff --git a/R/get_example_grid_germany.R b/R/get_example_grid_germany.R index a78c274f..ddd784f3 100644 --- a/R/get_example_grid_germany.R +++ b/R/get_example_grid_germany.R @@ -4,6 +4,8 @@ #' #' Read monthly potential evaporation of January 2022, just as an example. #' @export +#' @seealso +#' * [get_shapes_of_germany]. get_example_grid_germany <- function() { path <- "evapo_p/grids_germany_monthly_evapo_p_202201.asc.gz" diff --git a/R/get_radolan_projection_string.R b/R/get_radolan_projection_string.R index 0d22761f..2f28bf0c 100644 --- a/R/get_radolan_projection_string.R +++ b/R/get_radolan_projection_string.R @@ -6,6 +6,9 @@ #' @examples #' get_radolan_projection_string() #' +#' @seealso +#' * [get_radolan_urls], +#' * [get_radolan_extension]. get_radolan_projection_string <- function() { to_projection_string( diff --git a/R/get_radolan_urls.R b/R/get_radolan_urls.R index edf62d12..bae84be1 100644 --- a/R/get_radolan_urls.R +++ b/R/get_radolan_urls.R @@ -39,6 +39,10 @@ #' #' urls$daily_historical_urls #' +#' @seealso +#' * [get_dwd_urls_metadata], +#' * [get_radolan_extension], +#' * [get_radolan_projection_string]. get_radolan_urls <- function( start_daily = "2006-10", start_hourly = "2005-06", diff --git a/R/get_shapes_of_germany.R b/R/get_shapes_of_germany.R index 9b9b6e2c..fbd2b81f 100644 --- a/R/get_shapes_of_germany.R +++ b/R/get_shapes_of_germany.R @@ -9,6 +9,9 @@ #' file, provided that the file exists. #' @param use_sf passed to `kwb.dwd:::transform_coords` #' @export +#' @seealso +#' * [get_example_grid_germany], +#' * [check_or_download_shapes_germany]. get_shapes_of_germany <- function(recreate = FALSE, use_sf = FALSE) { if (!recreate) { diff --git a/R/list_extracted_radolan_files.R b/R/list_extracted_radolan_files.R index e8a008c9..0993e6af 100644 --- a/R/list_extracted_radolan_files.R +++ b/R/list_extracted_radolan_files.R @@ -14,6 +14,8 @@ #' time `resolution` and time interval (specified by `from` and #' `to`). #' @export +#' @seealso +#' * [extract_radolan_zip_files]. list_extracted_radolan_files <- function(from, to, resolution, format) { # resolution = "daily" diff --git a/R/list_url.R b/R/list_url.R index 437d19cd..1d426130 100644 --- a/R/list_url.R +++ b/R/list_url.R @@ -15,6 +15,8 @@ #' @export #' @importFrom kwb.utils listToDepth selectColumns #' @importFrom RCurl getCurlHandle +#' @seealso +#' * [list_extracted_radolan_files]. list_url <- function( url = ftp_path_cdc(), recursive = ! is.na(max_depth), diff --git a/R/load_monthly_data_for_berlin.R b/R/load_monthly_data_for_berlin.R index 4ebe94aa..97fd9692 100644 --- a/R/load_monthly_data_for_berlin.R +++ b/R/load_monthly_data_for_berlin.R @@ -16,6 +16,10 @@ #' * `n_values` (number of considered values) #' of potential evaporation calculated for Berlin, Germany #' @export +#' @seealso +#' * [load_potential_evaporation_berlin_2], +#' * [get_berlin_dwd_mask], +#' * [load_precipitation_berlin]. load_potential_evaporation_berlin <- function(from = NULL, to = NULL) { load_monthly_variable_for_region( @@ -40,6 +44,10 @@ load_potential_evaporation_berlin <- function(from = NULL, to = NULL) #' * `max` (maximum value) #' of precipitation calculated for Berlin, Germany #' @export +#' @seealso +#' * [load_potential_evaporation_berlin_2], +#' * [load_potential_evaporation_berlin], +#' * [get_berlin_dwd_mask]. load_precipitation_berlin <- function(from = NULL, to = NULL) { load_monthly_variable_for_region( @@ -67,6 +75,10 @@ load_precipitation_berlin <- function(from = NULL, to = NULL) #' * `n_values` (number of considered values) #' of potential evaporation calculated for Berlin, Germany #' @export +#' @seealso +#' * [load_potential_evaporation_berlin], +#' * [get_berlin_dwd_mask], +#' * [load_precipitation_berlin]. load_potential_evaporation_berlin_2 <- function(from, to) { load_monthly_variable_for_region( diff --git a/R/load_monthly_variable_for_region.R b/R/load_monthly_variable_for_region.R index 2d526915..f53317ef 100644 --- a/R/load_monthly_variable_for_region.R +++ b/R/load_monthly_variable_for_region.R @@ -62,6 +62,8 @@ load_monthly_variable_for_region <- function( #' @importFrom utils read.csv #' @examples #' get_berlin_dwd_mask() +#' @seealso +#' * [get_dwd_urls_metadata]. get_berlin_dwd_mask <- function() { # DWD matrix filled with NA @@ -97,6 +99,8 @@ get_berlin_dwd_mask <- function() #' @export #' @importFrom kwb.utils getAttribute #' @importFrom stats sd +#' @seealso +#' * [get_example_grid_germany]. calculate_masked_grid_stats <- function(matrices, geo_mask) { # Start with metadata from matrices' attributes: file name, year, month diff --git a/R/radolan_raw_to_raster.R b/R/radolan_raw_to_raster.R index bca11362..0752a86e 100644 --- a/R/radolan_raw_to_raster.R +++ b/R/radolan_raw_to_raster.R @@ -7,6 +7,11 @@ #' @return ??? #' @export #' @importFrom raster flip raster +#' @seealso +#' * [get_radolan_urls], +#' * [extract_radolan_zip_files], +#' * [download_radolan], +#' * [list_extracted_radolan_files]. radolan_raw_to_raster <- function(rbi, version = 3) { stopifnot(version %in% 1:3) diff --git a/R/read_asc_gz_file.R b/R/read_asc_gz_file.R index c0a85f27..885c9913 100644 --- a/R/read_asc_gz_file.R +++ b/R/read_asc_gz_file.R @@ -8,6 +8,9 @@ #' @export #' @importFrom kwb.utils callWith removeExtension tempSubdirectory #' @importFrom raster raster +#' @seealso +#' * [read_binary_radolan_file], +#' * [unzip_asc_gz_file]. read_asc_gz_file <- function(file, url = NULL) { target_dir <- if (is.null(url)) { diff --git a/R/read_binary_radolan_file.R b/R/read_binary_radolan_file.R index dbb2148a..81a5f57e 100644 --- a/R/read_binary_radolan_file.R +++ b/R/read_binary_radolan_file.R @@ -15,6 +15,9 @@ #' @export #' @importFrom sp CRS #' @importFrom raster extent +#' @seealso +#' * [read_asc_gz_file], +#' * [read_relevant_years_radolan]. read_binary_radolan_file <- function( path, set_projection_and_extent = TRUE, @@ -51,6 +54,9 @@ read_binary_radolan_file <- function( #' @examples #' get_radolan_extension() #' +#' @seealso +#' * [get_radolan_urls], +#' * [get_radolan_projection_string]. get_radolan_extension <- function() { c(-523.4622, 376.5378, -4658.645, -3758.645) diff --git a/R/read_daily_data_over_shape.R b/R/read_daily_data_over_shape.R index 1aad6950..fd1c2004 100644 --- a/R/read_daily_data_over_shape.R +++ b/R/read_daily_data_over_shape.R @@ -13,6 +13,11 @@ #' @param quiet passed to [download.file] #' @return data frame #' @export +#' @seealso +#' * [read_monthly_data_over_shape], +#' * [read_binary_radolan_file], +#' * [read_asc_gz_file], +#' * [read_relevant_years_radolan]. read_daily_data_over_shape <- function(file, variable, from, to, quiet = FALSE) { # Define scaling factors per variable. Depending on the variable, the values diff --git a/R/read_monthly_data_over_shape.R b/R/read_monthly_data_over_shape.R index 72062648..d10591d6 100644 --- a/R/read_monthly_data_over_shape.R +++ b/R/read_monthly_data_over_shape.R @@ -15,6 +15,11 @@ #' such as `drop_z = TRUE`, if applicable #' @return data frame #' @export +#' @seealso +#' * [read_binary_radolan_file], +#' * [read_asc_gz_file], +#' * [read_relevant_years_radolan], +#' * [read_daily_data_over_shape]. read_monthly_data_over_shape <- function( file = NULL, variable, diff --git a/R/read_relevant_years_radolan.R b/R/read_relevant_years_radolan.R index f03a4ec0..3eac7d24 100644 --- a/R/read_relevant_years_radolan.R +++ b/R/read_relevant_years_radolan.R @@ -11,6 +11,8 @@ #' @importFrom kwb.utils left #' @importFrom raster stack #' @importFrom stats setNames +#' @seealso +#' * [read_binary_radolan_file]. read_relevant_years_radolan <- function(path, years) { stopifnot(is.numeric(years)) diff --git a/R/unzip.R b/R/unzip.R index 8d6756ea..5b7db89a 100644 --- a/R/unzip.R +++ b/R/unzip.R @@ -9,6 +9,11 @@ #' @return path to the unzipped file #' @export #' @importFrom kwb.utils removeExtension +#' @seealso +#' * [read_binary_radolan_file], +#' * [convert_bin_to_raster_file], +#' * [read_asc_gz_file], +#' * [write_raster_to_file]. unzip_asc_gz_file <- function(file, target_dir = tempdir()) { # Path to the target file diff --git a/man/calculate_masked_grid_stats.Rd b/man/calculate_masked_grid_stats.Rd index 1e677f41..057c70dc 100644 --- a/man/calculate_masked_grid_stats.Rd +++ b/man/calculate_masked_grid_stats.Rd @@ -26,3 +26,8 @@ data frame with one row per matrix in \code{matrices} and columns \description{ Calculate Stats of Variable for Geographical Subset of a Grid } +\seealso{ +\itemize{ +\item \link{get_example_grid_germany}. +} +} diff --git a/man/check_or_download_shapes_germany.Rd b/man/check_or_download_shapes_germany.Rd index 952d68f1..824e6246 100644 --- a/man/check_or_download_shapes_germany.Rd +++ b/man/check_or_download_shapes_germany.Rd @@ -27,3 +27,10 @@ This function checks if shape files for Germany are available in the folder \verb{\\\%TEMP\\\%/R_kwb.dwd/shapes_germany}. If not, the shape files are downloaded from the URL given in \code{url} and unpacked into that folder. } +\seealso{ +\itemize{ +\item \link{get_shapes_of_germany}, +\item \link{get_example_grid_germany}, +\item \link{download_radolan}. +} +} diff --git a/man/convert_bin_to_raster_file.Rd b/man/convert_bin_to_raster_file.Rd index 9a220fa6..9d5b999c 100644 --- a/man/convert_bin_to_raster_file.Rd +++ b/man/convert_bin_to_raster_file.Rd @@ -18,3 +18,8 @@ the first element of \code{bin_file} resides.} \description{ Convert Binary Radolan File to Raster File } +\seealso{ +\itemize{ +\item \link{write_raster_to_file}. +} +} diff --git a/man/crop_radolan_radial.Rd b/man/crop_radolan_radial.Rd index d85cbec8..01e4f652 100644 --- a/man/crop_radolan_radial.Rd +++ b/man/crop_radolan_radial.Rd @@ -28,3 +28,11 @@ object returned by \link[raster:crop]{raster::crop}} \description{ Crop Radolan Data } +\seealso{ +\itemize{ +\item \link{get_radolan_urls}, +\item \link{extract_radolan_zip_files}, +\item \link{radolan_raw_to_raster}, +\item \link{download_radolan}. +} +} diff --git a/man/download_radolan.Rd b/man/download_radolan.Rd index 8b290307..03bb2e96 100644 --- a/man/download_radolan.Rd +++ b/man/download_radolan.Rd @@ -25,3 +25,11 @@ Download Radolan Files on DWD Server \examples{ \dontrun{download_radolan(resolution = "daily")} } +\seealso{ +\itemize{ +\item \link{get_radolan_urls}, +\item \link{extract_radolan_zip_files}, +\item \link{radolan_raw_to_raster}, +\item \link{list_extracted_radolan_files}. +} +} diff --git a/man/extract_radolan_zip_files.Rd b/man/extract_radolan_zip_files.Rd index 71fd9aa2..e8a186ad 100644 --- a/man/extract_radolan_zip_files.Rd +++ b/man/extract_radolan_zip_files.Rd @@ -17,3 +17,8 @@ Nothing. Side effect: Unzipped files in subfolder "bin" below \description{ Extract radolan zip files } +\seealso{ +\itemize{ +\item \link{list_extracted_radolan_files}. +} +} diff --git a/man/get_berlin_dwd_mask.Rd b/man/get_berlin_dwd_mask.Rd index edd4b9a9..4f7f3078 100644 --- a/man/get_berlin_dwd_mask.Rd +++ b/man/get_berlin_dwd_mask.Rd @@ -15,3 +15,8 @@ Get geographical "stamp" for Berlin area \examples{ get_berlin_dwd_mask() } +\seealso{ +\itemize{ +\item \link{get_dwd_urls_metadata}. +} +} diff --git a/man/get_dwd_urls_metadata.Rd b/man/get_dwd_urls_metadata.Rd index f94131dd..25c1f611 100644 --- a/man/get_dwd_urls_metadata.Rd +++ b/man/get_dwd_urls_metadata.Rd @@ -14,3 +14,9 @@ file provided by Deutscher Wetterdienst (DWT), e.g. files \description{ Get URLs to DWD Metadata } +\seealso{ +\itemize{ +\item \link{get_radolan_urls}, +\item \link{get_berlin_dwd_mask}. +} +} diff --git a/man/get_example_grid_germany.Rd b/man/get_example_grid_germany.Rd index c386a98e..0553c90c 100644 --- a/man/get_example_grid_germany.Rd +++ b/man/get_example_grid_germany.Rd @@ -9,3 +9,8 @@ get_example_grid_germany() \description{ Read monthly potential evaporation of January 2022, just as an example. } +\seealso{ +\itemize{ +\item \link{get_shapes_of_germany}. +} +} diff --git a/man/get_radolan_extension.Rd b/man/get_radolan_extension.Rd index e76d25c6..f87ea8bb 100644 --- a/man/get_radolan_extension.Rd +++ b/man/get_radolan_extension.Rd @@ -16,3 +16,9 @@ Get Radolan Extension get_radolan_extension() } +\seealso{ +\itemize{ +\item \link{get_radolan_urls}, +\item \link{get_radolan_projection_string}. +} +} diff --git a/man/get_radolan_projection_string.Rd b/man/get_radolan_projection_string.Rd index 44fb2362..67b33cf8 100644 --- a/man/get_radolan_projection_string.Rd +++ b/man/get_radolan_projection_string.Rd @@ -16,3 +16,9 @@ Compose radolan projection string get_radolan_projection_string() } +\seealso{ +\itemize{ +\item \link{get_radolan_urls}, +\item \link{get_radolan_extension}. +} +} diff --git a/man/get_radolan_urls.Rd b/man/get_radolan_urls.Rd index 71e0223c..afa4dfe3 100644 --- a/man/get_radolan_urls.Rd +++ b/man/get_radolan_urls.Rd @@ -56,3 +56,10 @@ urls <- kwb.dwd::get_radolan_urls( urls$daily_historical_urls } +\seealso{ +\itemize{ +\item \link{get_dwd_urls_metadata}, +\item \link{get_radolan_extension}, +\item \link{get_radolan_projection_string}. +} +} diff --git a/man/get_shapes_of_germany.Rd b/man/get_shapes_of_germany.Rd index 22a20e03..e31dfa1d 100644 --- a/man/get_shapes_of_germany.Rd +++ b/man/get_shapes_of_germany.Rd @@ -18,3 +18,9 @@ file, provided that the file exists.} \description{ Provide List of SpatialPolygonsDataFrame for Germany } +\seealso{ +\itemize{ +\item \link{get_example_grid_germany}, +\item \link{check_or_download_shapes_germany}. +} +} diff --git a/man/list_extracted_radolan_files.Rd b/man/list_extracted_radolan_files.Rd index fb16b663..3d60ca65 100644 --- a/man/list_extracted_radolan_files.Rd +++ b/man/list_extracted_radolan_files.Rd @@ -27,3 +27,8 @@ time \code{resolution} and time interval (specified by \code{from} and \description{ List the Locally Available Extracted Files } +\seealso{ +\itemize{ +\item \link{extract_radolan_zip_files}. +} +} diff --git a/man/list_url.Rd b/man/list_url.Rd index 4a043876..6a9a56ce 100644 --- a/man/list_url.Rd +++ b/man/list_url.Rd @@ -33,3 +33,8 @@ default) only the paths relative to \code{url}.} \description{ List Files or Folders in a FTP Directory } +\seealso{ +\itemize{ +\item \link{list_extracted_radolan_files}. +} +} diff --git a/man/load_potential_evaporation_berlin.Rd b/man/load_potential_evaporation_berlin.Rd index 96c88a5f..236606f6 100644 --- a/man/load_potential_evaporation_berlin.Rd +++ b/man/load_potential_evaporation_berlin.Rd @@ -29,3 +29,10 @@ of potential evaporation calculated for Berlin, Germany This function loads monthly potential evaporation for Berlin, Germany, from Deutscher Wetterdienst (DWD). } +\seealso{ +\itemize{ +\item \link{load_potential_evaporation_berlin_2}, +\item \link{get_berlin_dwd_mask}, +\item \link{load_precipitation_berlin}. +} +} diff --git a/man/load_potential_evaporation_berlin_2.Rd b/man/load_potential_evaporation_berlin_2.Rd index aa8123c6..5daa457c 100644 --- a/man/load_potential_evaporation_berlin_2.Rd +++ b/man/load_potential_evaporation_berlin_2.Rd @@ -29,3 +29,10 @@ of potential evaporation calculated for Berlin, Germany This version uses publicly available shape files to determine the area that is covered by Berlin. This function can easily be adopted to other cities! } +\seealso{ +\itemize{ +\item \link{load_potential_evaporation_berlin}, +\item \link{get_berlin_dwd_mask}, +\item \link{load_precipitation_berlin}. +} +} diff --git a/man/load_precipitation_berlin.Rd b/man/load_precipitation_berlin.Rd index 17a3abd8..abeac757 100644 --- a/man/load_precipitation_berlin.Rd +++ b/man/load_precipitation_berlin.Rd @@ -28,3 +28,10 @@ of precipitation calculated for Berlin, Germany This function loads monthly precipitation for Berlin, Germany, from Deutscher Wetterdienst (DWD). } +\seealso{ +\itemize{ +\item \link{load_potential_evaporation_berlin_2}, +\item \link{load_potential_evaporation_berlin}, +\item \link{get_berlin_dwd_mask}. +} +} diff --git a/man/radolan_raw_to_raster.Rd b/man/radolan_raw_to_raster.Rd index f0c4b998..26732dd6 100644 --- a/man/radolan_raw_to_raster.Rd +++ b/man/radolan_raw_to_raster.Rd @@ -17,3 +17,11 @@ radolan_raw_to_raster(rbi, version = 3) \description{ Radolan raw to raster } +\seealso{ +\itemize{ +\item \link{get_radolan_urls}, +\item \link{extract_radolan_zip_files}, +\item \link{download_radolan}, +\item \link{list_extracted_radolan_files}. +} +} diff --git a/man/read_asc_gz_file.Rd b/man/read_asc_gz_file.Rd index a998f14a..82a70402 100644 --- a/man/read_asc_gz_file.Rd +++ b/man/read_asc_gz_file.Rd @@ -17,3 +17,9 @@ object of class "RasterLayer" \description{ Read Zipped ESRI-Ascii-Grid File (from URL) } +\seealso{ +\itemize{ +\item \link{read_binary_radolan_file}, +\item \link{unzip_asc_gz_file}. +} +} diff --git a/man/read_binary_radolan_file.Rd b/man/read_binary_radolan_file.Rd index ae5d1459..50d1e03a 100644 --- a/man/read_binary_radolan_file.Rd +++ b/man/read_binary_radolan_file.Rd @@ -27,3 +27,9 @@ in future!} \description{ Read Binary Radolan File } +\seealso{ +\itemize{ +\item \link{read_asc_gz_file}, +\item \link{read_relevant_years_radolan}. +} +} diff --git a/man/read_daily_data_over_shape.Rd b/man/read_daily_data_over_shape.Rd index bc4a2072..714468f6 100644 --- a/man/read_daily_data_over_shape.Rd +++ b/man/read_daily_data_over_shape.Rd @@ -25,3 +25,11 @@ data frame Currently, only full months of data can be loaded, \code{from} and \code{to} must be given } +\seealso{ +\itemize{ +\item \link{read_monthly_data_over_shape}, +\item \link{read_binary_radolan_file}, +\item \link{read_asc_gz_file}, +\item \link{read_relevant_years_radolan}. +} +} diff --git a/man/read_monthly_data_over_shape.Rd b/man/read_monthly_data_over_shape.Rd index cc39f24f..ac6bc6ba 100644 --- a/man/read_monthly_data_over_shape.Rd +++ b/man/read_monthly_data_over_shape.Rd @@ -41,3 +41,11 @@ data frame \description{ Read monthly data from DWD, mask region with given shape file } +\seealso{ +\itemize{ +\item \link{read_binary_radolan_file}, +\item \link{read_asc_gz_file}, +\item \link{read_relevant_years_radolan}, +\item \link{read_daily_data_over_shape}. +} +} diff --git a/man/read_relevant_years_radolan.Rd b/man/read_relevant_years_radolan.Rd index 42eae3bf..7014be10 100644 --- a/man/read_relevant_years_radolan.Rd +++ b/man/read_relevant_years_radolan.Rd @@ -15,3 +15,8 @@ read_relevant_years_radolan(path, years) This function reads in relevant radolan data from rst database based on used input data } +\seealso{ +\itemize{ +\item \link{read_binary_radolan_file}. +} +} diff --git a/man/unzip_asc_gz_file.Rd b/man/unzip_asc_gz_file.Rd index 5920b7ea..00319405 100644 --- a/man/unzip_asc_gz_file.Rd +++ b/man/unzip_asc_gz_file.Rd @@ -19,3 +19,11 @@ path to the unzipped file \description{ Download a .gz File and Unzip it } +\seealso{ +\itemize{ +\item \link{read_binary_radolan_file}, +\item \link{convert_bin_to_raster_file}, +\item \link{read_asc_gz_file}, +\item \link{write_raster_to_file}. +} +} diff --git a/man/write_raster_to_file.Rd b/man/write_raster_to_file.Rd index 1b217458..b2be6313 100644 --- a/man/write_raster_to_file.Rd +++ b/man/write_raster_to_file.Rd @@ -19,3 +19,8 @@ write raster to file \description{ Write raster to file } +\seealso{ +\itemize{ +\item \link{convert_bin_to_raster_file}. +} +}