getBIDtables: A function to retrieve the BinaryID tables associated with a...

Description Usage Arguments Details Value Examples

View source: R/getBIDtables.R

Description

Retrieves the Binary ID tables which are stored in a database in the path slot of a SpatialStreamNetwork object and returns them as a list of data.frame objects.

Usage

1
getBIDtables(ssn.object, networks = 1:nnetwork(ssn.object))

Arguments

ssn.object

An object of class SpatialStreamNetwork.

networks

A numeric vector of the networks in a SpatialStreamNetwork object for which the binary ID tables should be extracted.

Details

The ssn.object must have a valid folder path stored in its path slot. This folder must contain a binaryID.db database.

Value

A named list of length length(networks) containing the binary ID tables for each of these networks.

Examples

1
2
3
4
5
6
7
8
9
# Single network
s <- createSSN(50, binomialDesign(20), 
path = tempPath("example04.ssn"), importToR = TRUE)
tabs <- getBIDtables(s)

# Multiple networks
s <- createSSN(c(50, 50), binomialDesign(c(20, 20)),
path = tempPath("example05.ssn"), importToR = TRUE)
tabs <- getBIDtables(s)

apear9/SSNdesign documentation built on Feb. 19, 2020, 4:29 a.m.