Skip to content

Commit

Permalink
bold.analyze.map documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sameerpadhye committed Sep 13, 2024
1 parent 9a4cc01 commit d15622d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion R/bold.analyze.map.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion man/bold.analyze.map.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d15622d

Please sign in to comment.