R: Create Indices for PolySets

dot-create {PBSmapping}

R Documentation

Create Indices for PolySets

Description

Create indices for indexing map data structures (PolySets).

Usage

.createIDs(x, cols, fastIDdig=NULL)
.createFastIDdig(polysA, polysB=NULL, cols)
.createGridIDs(d, addSID, byrow)

Arguments

x

data.frame – PolySet with one or more ID columns

cols

character – field (or column) names (e.g., ('PID','SID'))

fastIDdig

numeric – maximum number of digits in the second column; often the output from '.createFastIDdig' is passed to 'fastIDdig' when creating (some) matching indices for two different data frames

polysA

data.frame – first PolySet data frame

polysB

data.frame – second PolySet data frame, which may be missing one or both 'cols'

d

data.frame – grid Polyset created using addSID=T and byrow=T

addSID

logical – if TRUE, include a 'SID' column

byrow

logical – if TRUE, increment 'PID' along 'X'

Details

.createIDs : create IDs (or IDX) column from its input.

.createFastIDdig : determine the maximum number of digits in the second column of a data frame. If given two data frames ('polysA' and 'polysB'), determine the maximum between the two data frames.

.createGridIDs : Create IDs for a grid according to the addSID and byrow arguments.

Value

.createIDs : a vector of integer or real-number indices.

.createFastIDdig : maximum number of digits to use in real-number index.

.createGridIDs : a modified grid PolySet.

Author(s)

Nicholas M. Boers, Software Engineer, Jobber, Edmonton AB

Maintainer: Rowan Haigh, Program Head – Offshore Rockfish
Pacific Biological Station (PBS), Fisheries & Oceans Canada (DFO), Nanaimo BC
locus opus: Remote office, Vancouver BC
Last modified Rd: 2024-09-25