appendPolys {PBSmapping}R Documentation

Append a Two-Column Matrix to a PolySet

Description

Appends a two-column matrix to a PolySet, assigning PID and possibly SID values automatically or as specified in its arguments.

Usage

appendPolys (polys, mat, PID = NULL, SID = NULL, isHole = FALSE)

Arguments

polys existing PolySet; if NULL, creates a new PolySet (required).
mat two-column matrix to append (required).
PID new polygon's PID.
SID new polygon's SID.
isHole Boolean value; if TRUE, mat represents a hole.

Details

If polys contains an SID column and the SID argument equals NULL, this function uses the next available SID.

If polys does not contain an SID column and the caller passes an SID argument, all existing polygons will receive an SID of 1. The new polygon's SID will match the SID argument.

If isHole = TRUE, the polygon's POS values will appropriately represent a hole (reverse order of POS).

If (PID, SID) already exists in the PolySet, the function will issue a warning and duplicate those identifiers.

Value

PolySet containing mat appended to polys. The function retains attributes from polys.

See Also

addPolys, clipPolys, closePolys, convLP, fixBound, fixPOS, joinPolys, plotMap, plotPolys.

Examples

  #--- create two simple matrices
  a <- matrix(data=c(0, 0, 1, 0, 1, 1, 0, 1), ncol=2, byrow = TRUE);
  b <- matrix(data=c(2, 2, 3, 2, 3, 3, 2, 3), ncol=2, byrow = TRUE);
  #--- build a PolySet from them
  polys <- appendPolys(NULL, a);
  polys <- appendPolys(polys, b);
  #--- print the result
  print (polys);

[Package PBSmapping version 2.09 Index]