ddi_boundPoly: boundPoly and its child nodes

View source: R/stdyInfo.R

ddi_boundPolyR Documentation

boundPoly and its child nodes

Description

The geographic bounding polygon field allows the creation of multiple polygons to describe in a more detailed manner the geographic area covered by the dataset. It should only be used to define the outer boundaries of a covered area. For example, in the United States, such polygons can be created to define boundaries for Hawaii, Alaska, and the continental United States, but not interior boundaries for the contiguous states. This field is used to refine a coordinate-based search, not to actually map an area. If the boundPoly element is used, then geoBndBox MUST be present, and all points enclosed by the boundPoly MUST be contained within the geoBndBox. Elements westBL, eastBL, southBL, and northBL of the geoBndBox should each be represented in at least one point of the boundPoly description. More information on these elements, especially their allowed attributes, can be found in the references.

Usage

ddi_boundPoly(...)

Arguments

...

Child nodes or attributes.

Details

Parent nodes

boundPoly is contained in sumDscr.

Value

A ddi_node object.

Shared and complex child nodes

  • ddi_polygon()

References

boundPoly documentation

Examples

# ddi_boundPoly requires ddi_polygon(). ddi_polygon then requires ddi_point()
# which requires ddi_gringLat() and ddi_gringLon()

ddi_boundPoly(ddi_polygon(
                ddi_point(
                   ddi_gringLat("42.002207"), 
                   ddi_gringLon("-120.005729004")
                 )
               )
             )


Global-TIES-for-Children/rddi documentation built on Oct. 24, 2022, 9:50 p.m.