blockedSN: Blocked sorted neighbors generic.

Description Usage Arguments Value

Description

blockedSN returns a Blocks object created from a single iteration of the blocked sorted neighbors algorithm.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
blockedSN(object, blockVar, repSN, windowSN, keyLength)

## Default S3 method:
blockedSN(object, blockVar, repSN, windowSN, keyLength)

## S3 method for class 'Neighbors'
blockedSN(object, blockVar, repSN, windowSN, keyLength)

## S3 method for class 'Blocks'
blockedSN(object, blockVar, repSN, windowSN, keyLength)

## S3 method for class 'Scores'
blockedSN(object, blockVar, repSN, windowSN, keyLength)

Arguments

object

Neighbors or Blocks object to perform BSN algorithm on.

blockVar

Integer or character value. The column on which to block.

repSN

Integer value. How much iterations of sorted neighbors to perform?

windowSN

Integer value. Size of sliding window to use during sorted neighbrs.

keyLength

Numeric value or vector. How many keyVars to concatenate per sort key.

Value

An object of class Blocks containing the neighbors found and keys used during the blocked sorted neighbors iteration.


mPloenzke/bsnR documentation built on May 21, 2019, 9:18 a.m.