From d15622defe805f9125dbb450efb7f52663fff253 Mon Sep 17 00:00:00 2001 From: Sameer Padhye Date: Fri, 13 Sep 2024 11:14:53 -0400 Subject: [PATCH] bold.analyze.map documentation --- R/bold.analyze.map.R | 2 +- man/bold.analyze.map.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/bold.analyze.map.R b/R/bold.analyze.map.R index fcff9992..0d2e8072 100644 --- a/R/bold.analyze.map.R +++ b/R/bold.analyze.map.R @@ -10,7 +10,7 @@ #' @param bbox A numeric vector specifying the min, max values of the latitude and longitude. Default value is NULL. #' -#' @details `bold.analyze.map` extracts out the geographic information from the [bold.fetch()] output. Data points having NA values for either latitude or longitude or both are removed. Latitude and longitude values are in ‘decimal degrees’ format with a ’WGS84’ Coordinate Reference System (CRS) projection. Default view includes data mapped onto a world shape file using the `rnaturalearth::ne_countries()` at a 110 scale (low resolution). If the country is specified (single or multiple values), the function will specifically plot the occurrences on the specified country. Alternatively, a bounding box (bbox) can be defined for a specific region to be visualized. The function also provides a sf data frame of the GIS data which can be used for any other application/s. +#' @details `bold.analyze.map` extracts out the geographic information from the [bold.fetch()] output to generate an occurrence map. Data points having NA values for either latitude or longitude or both are removed. Latitude and longitude values are in ‘decimal degrees’ format with a ’WGS84’ Coordinate Reference System (CRS) projection. Default view includes data mapped onto a world shape file using the `rnaturalearth::ne_countries()` at a 110 scale (low resolution). If the country is specified (single or multiple values), the function will specifically plot the occurrences on the specified country. Alternatively, a bounding box (bbox) can be defined for a specific region to be visualized. The function also provides a `sf` data frame of the GIS data which can be used for any other application/s. #' #' @returns An 'output' list containing: #' * geo.df = A simple features (sf) ‘data.frame’ containing the geographic data. diff --git a/man/bold.analyze.map.Rd b/man/bold.analyze.map.Rd index fc0beec4..5050480c 100644 --- a/man/bold.analyze.map.Rd +++ b/man/bold.analyze.map.Rd @@ -24,7 +24,7 @@ An 'output' list containing: This function creates basic maps of BIN occurrence data at different scales. } \details{ -\code{bold.analyze.map} extracts out the geographic information from the \code{\link[=bold.fetch]{bold.fetch()}} output. Data points having NA values for either latitude or longitude or both are removed. Latitude and longitude values are in ‘decimal degrees’ format with a ’WGS84’ Coordinate Reference System (CRS) projection. Default view includes data mapped onto a world shape file using the \code{rnaturalearth::ne_countries()} at a 110 scale (low resolution). If the country is specified (single or multiple values), the function will specifically plot the occurrences on the specified country. Alternatively, a bounding box (bbox) can be defined for a specific region to be visualized. The function also provides a sf data frame of the GIS data which can be used for any other application/s. +\code{bold.analyze.map} extracts out the geographic information from the \code{\link[=bold.fetch]{bold.fetch()}} output to generate an occurrence map. Data points having NA values for either latitude or longitude or both are removed. Latitude and longitude values are in ‘decimal degrees’ format with a ’WGS84’ Coordinate Reference System (CRS) projection. Default view includes data mapped onto a world shape file using the \code{rnaturalearth::ne_countries()} at a 110 scale (low resolution). If the country is specified (single or multiple values), the function will specifically plot the occurrences on the specified country. Alternatively, a bounding box (bbox) can be defined for a specific region to be visualized. The function also provides a \code{sf} data frame of the GIS data which can be used for any other application/s. } \examples{ \dontrun{