mr_place_relations: Related records

Description Usage Arguments Author(s) Examples

View source: R/place_relations.R

Description

Get related records based on their MRGID.

Usage

1
2
3
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 GET

Author(s)

Francois Michonneau <francois.michonneau@gmail.com>

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## 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)

mregions documentation built on May 2, 2019, 6:53 a.m.