generate_scanList: Generator for 'scanList' objects Internal use. The user...

In R-KenK/SimuNet: Network Simulation Framework, with a Zest of Empiricism

Description

Generator for scanList objects Internal use. The user should rather rely on simunet as a wrapper for the different steps needed to perform the simulations from inputted data.

Usage

generate_scanList(edge.Prob, n.scans)

Arguments

edge.Prob	an edgeProb object, i.e. a list containing: P: the edge presence probability matrix Adj: the inputted Adj samp.effort: the inputted samp.effort mode: the inputted mode Adj.subfun: the inputted Adj.subfun
samp.effort	integer scalar, the sampling effort, or number of scans, that led to obtaining of Adj

Value

a theoretical inheriting from scanList object, primarily a 3 dimensional array representing the (binary) adjacency matrices (coded within the first two dimensions of the 3D-array) obtained at each simulated scan (coded as the 3rd dimension of the 3D-array), and a list of attributes, attrs.

The list of attributes attrs contains:

• scanList.type: character scalar, "theoretical" at first and "empirical" after a non-NULL experimental manipulation has been applied to the scanList (via perform_exp() and a expDesign object)

• raw.scanList: the 3D binary array, directed, before potential symmetrization attempt by applying the igraph's mode via apply_mode()

• Adj: integer matrix, Adj contained in edge.Prob

• samp.effort: integer, samp.effort contained in edge.Prob

• n.scans: inputted n.scans

• mode: character scalar, mode contained in edge.Prob

• Adj.subfun: function, Adj.subfun contained in edge.Prob

• edge.Prob: numeric matrix,edge.Prob$P (only the probability matrix) data contained in edge.Prob

See Also

simunet(), generate_edgeProb(), draw_edgeProb(), generate_empiscanList().

R-KenK/SimuNet documentation built on Oct. 22, 2021, 1:27 a.m.