mr_place_relations: Related records
In ropenscilabs/mregions: Marine Regions Data from 'Marineregions.org'

View source: R/place_relations.R

mr_place_relations

R Documentation

Related records

Description

Get related records based on their MRGID.

Usage

mr_place_relations(
  mrgid,
  direction = c("upper", "lower", "both"),
  type = c("partof", "partlypartof", "adjacentto", "similarto", "administrativepartof",
    "influencedby", "all"),
  ...
)

Arguments

`mrgid`	(numeric) the MRGID (Marineregions Global Identifier) for the record of interest
`direction`	(character) in which direction of the geographical hierarchy should the records be retrieved? Default: `upper`
`type`	(character) what kind of relations should the records retrieve have with the place? Default: `partof`
`...`	curl options to be passed on to `httr::GET()`

Author(s)

Francois Michonneau francois.michonneau@gmail.com

Examples

## Not run: 
## geocode to get geospatial data for a place name
(tikehau <- mr_geo_code("tikehau"))

## then pass in in an MRGID as the first parameter
mr_place_relations(tikehau$MRGID)

## Set direction='both'
mr_place_relations(tikehau$MRGID, direction = "both")

## Set type to various other options
mr_place_relations(307, type = "adjacentto")
mr_place_relations(414, type = "similarto")
mr_place_relations(4177, type = "all")

## End(Not run)

ropenscilabs/mregions documentation built on Sept. 4, 2024, 5:59 p.m.