get_locations: Obtaining locations for a SAFE dataset.

View source: R/locations.R

get_locationsR Documentation

Obtaining locations for a SAFE dataset.


This function returns a spatial 'simple features' (sf) object for a dataset record, including basic information about locations for the SAFE gazetteer if requested.


get_locations(obj, gazetteer_info = FALSE)



A single record id, or an existing safedata dataframe.


Should all the gazetteer fields be included in the returned sf object.


All SAFE datasets recording observations from the field must include a Locations worksheet, which must contain all of the location names used in Locations type fields in data worksheets. These entries are matched against existing location names in the SAFE gazetteer. Users can also include "new" location names in their dataset, which do not necessarily have coordinates. Processing locations works as follows:

  1. Known locations (new_location = FALSE) are matched against both the official location names in the gazetteer and the accepted aliases.

  2. New locations are first checked against the location aliases list to see if any new locations in this dataset have been matched to a gazetteer location. The gazetteer location is then used in preference to any new location data within the dataset.

  3. Finally, remaining new locations are assigned any feature geometry within the dataset. New locations do not necessarily have geometry data, so may have null or empty geometries.


An object of classes "safe_locations", "sf" and "data.frame".


Not all SAFE project datasets contain locations. In this case get_locations will return NULL.

See Also

add_locations, load_gazetteer, load_location_aliases


   locations <- get_locations(1400562)

safedata documentation built on April 25, 2022, 5:05 p.m.