CoordinateCleaner: cc_zero – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

cc_zero

Identify Zero Coordinates

Description

Removes or flags records with either zero longitude or latitude and a radius around the point at zero longitude and zero latitude. These problems are often due to erroneous data-entry or geo-referencing and can lead to typical patterns of high diversity around the equator.

Usage

cc_zero(
  x,
  lon = "decimallongitude",
  lat = "decimallatitude",
  buffer = 0.5,
  value = "clean",
  verbose = TRUE
)

Arguments

`x`	data.frame. Containing geographical coordinates and species names.
`lon`	character string. The column with the longitude coordinates. Default = “decimallongitude”.
`lat`	character string. The column with the latitude coordinates. Default = “decimallatitude”.
`buffer`	numerical. The buffer around the 0/0 point, where records should be flagged as problematic, in decimal degrees. Default = 0.1.
`value`	character string. Defining the output value. See value.
`verbose`	logical. If TRUE reports the name of the test and the number of records flagged.

Value

Depending on the ‘value’ argument, either a data.frame containing the records considered correct by the test (“clean”) or a logical vector (“flagged”), with TRUE = test passed and FALSE = test failed/potentially problematic . Default = “clean”.

Note

See https://ropensci.github.io/CoordinateCleaner/ for more details and tutorials.

Examples

x <- data.frame(species = "A", 
                decimallongitude = c(0,34.84, 0, 33.98), 
                decimallatitude = c(23.08, 0, 0, 15.98))
                
cc_zero(x)
cc_zero(x, value = "flagged")

CoordinateCleaner

Automated Cleaning of Occurrence Records from Biological Collections

v2.0-18

GPL-3

Authors

Alexander Zizka [aut, cre], Daniele Silvestro [ctb], Tobias Andermann [ctb], Josue Azevedo [ctb], Camila Duarte Ritter [ctb], Daniel Edler [ctb], Harith Farooq [ctb], Andrei Herdean [ctb], Maria Ariza [ctb], Ruud Scharn [ctb], Sten Svanteson [ctb], Niklas Wengstrom [ctb], Vera Zizka [ctb], Alexandre Antonelli [ctb], Irene Steves [rev] (Irene reviewed the package for ropensci, see <https://github.com/ropensci/onboarding/issues/210>), Francisco Rodriguez-Sanchez [rev] (Francisco reviewed the package for ropensci, see <https://github.com/ropensci/onboarding/issues/210>)

Initial release