predict.nrm: Method to predict the expected values of a nrm model

In gi0na/ghypernet: Fit and Simulate Generalised Hypergeometric Ensembles of Graphs

Method to predict the expected values of a nrm model

Description

Method to predict the expected values of a nrm model

Usage

## S3 method for class 'nrm'
predict(object, m = NULL, adj = NULL, null = FALSE, multinomial = NULL, ...)

Arguments

object	nrm object from which to predict
m	integer, the number of edges to be used
adj	optional matrix, the adjacency matrix from which to get the number of edges
null	optional boolean, is it a null model? default FALSE
multinomial	logical. Optional argument. Whether to use multinomial approximation. If left blank it is selected automatically based on network size.
...	other arguments

Value

numeric, predicted values from nrm model. (If model is undirected, only upper.tri of adjacency matrix is returned.)

Examples

data('highschool.predictors')
highschool.m <- nrm(w=highschool.predictors[1], adj=contacts.adj, directed=FALSE, selfloops=FALSE)
predict(highschool.m, contacts.adj)

data('highschool.predictors')
highschool.m <- nrm(w=highschool.predictors, adj=contacts.adj, directed=FALSE, selfloops=FALSE)
predict(highschool.m, contacts.adj)

gi0na/ghypernet documentation built on April 13, 2024, 2:33 a.m.