Skip to contents

Check JamPolygon object

Source: R/JamPolygon.R
check_JamPolygon.Rd

Check whether a JamPolygon object is valid.

Usage

check_JamPolygon(object)

Arguments

object

JamPolygon object

Details

It requires:

  • slotName(object) to contain "polygons"

  • object@polygons to inherit "data.frame"

  • colnames(object@polygons) to contain c("name", "x", "y")

General guidance for JamPolygon objects:

  • Empty polygons can be represented as one row in the data.frame which contains NULL or numeric(0) x,y coordinates.

    • Empty polygons can be the result of intersect_JamPolygon() that finds no suitable intersect.

    • Note that downstream processing, and plotting, must account for empty polygons and handle or ignore them accordingly.

See also

Other JamPolygon: JamPolygon-class, [,JamPolygon-method, add_orientation_JamPolygon(), area_JamPolygon(), bbox_JamPolygon(), buffer_JamPolygon(), eulerr_to_JamPolygon(), farthest_point_JamPolygon(), find_venn_overlaps_JamPolygon(), has_point_in_JamPolygon(), intersect_JamPolygon(), label_fill_JamPolygon(), label_outside_JamPolygon(), label_segment_JamPolygon(), labelr_JamPolygon(), minus_JamPolygon(), nearest_point_JamPolygon(), nudge_JamPolygon(), plot.JamPolygon(), point_in_JamPolygon(), polyclip_to_JamPolygon(), polygon_circles(), polygon_ellipses(), sample_JamPolygon(), split_JamPolygon(), union_JamPolygon(), update_JamPolygon()