izGridMirage-methods: Methods for Function 'izGridMirage' in Package 'sampSurf'

Description Methods

Description

There is one method for generic function izGridMirage that will create objects of class "mirageInclusionZoneGrid".

Methods

signature(izObject = "InclusionZone", tract = "mirageTract")

Any arguments not defined below have the same definitions as those for the izGrid constructor (which is called first for the given izObject).

usage...

izGridMirage(izObject,
             tract,
             description = 'izGrid object using mirage',
             wholeIZ = TRUE, 
             truncateOverlap = FALSE, 
             ... )
  • izObject: An object of class "InclusionZone"

  • tract: An object of class "mirageTract".

  • description: A description of the object as a character string.

  • truncateOverlap: TRUE: truncate the estimates to zero for cells external to the tract; FALSE: keep the estimates. This only applies to the object in the izGrid.extended slot of the object. If TRUE, the extended grid will still be there, only with background cells rather than estimates. If FALSE, the estimates for the cells in the extended grid will be preserved.

  • ... : Other arguments to be passed along as described in the izGrid-methods constructor documentation.


sampSurf documentation built on March 5, 2021, 3:01 p.m.