sienaFit: Methods for processing sienaFit objects, produced by...

sienaFit.methodsR Documentation

Methods for processing sienaFit objects, produced by siena07.

Description

print, summary, and xtable methods for sienaFit objects.

Usage

## S3 method for class 'sienaFit'
print(x, tstat=TRUE, ...)

## S3 method for class 'sienaFit'
summary(object, ...)

## S3 method for class 'summary.sienaFit'
print(x, matrices=TRUE, ...)

## S3 method for class 'sienaFit'
xtable(x, caption = NULL, label = NULL, align = NULL,
                digits = NULL, display = NULL, ...)

siena.table(x, type="tex", file=paste(deparse(substitute(x)), ".", type,sep=""),
            vertLine=TRUE, tstatPrint=FALSE, sig=FALSE, d=3, nfirst=NULL)

Arguments

object

An object of class sienaFit, produced by siena07. For siena.table, objects of class sienaBayes are also permitted.

x

An object of class sienaFit, or summary.sienaFit as appropriate. For siena.table, objects of class sienaBayes are also permitted.

matrices

Boolean: whether also to print in the summary the covariance matrix of the estimates, the derivative matrix of expected statistics X by parameters, and the covariance matrix of the statistics.

tstat

Boolean: if this is NULL, the t-statistics for convergence will not be added to the report.

type

Type of output to produce; must be either "tex" or "html".

file

Name of the file; defaults to the name of the sienaFit object. "" indicates output to the console.

vertLine

Boolean: add vertical lines separating the columns in siena.table.

tstatPrint

Boolean: add a column of significance t values (parameter estimate/standard error estimate) to siena.table.

sig

Boolean: adds symbols (daggers and asterisks) indicating significance levels for the parameter estimates to siena.table.

d

The number of decimals places used in siena.table.

caption

See documentation for xtable.

label

See documentation for xtable.

align

See documentation for xtable.

digits

See documentation for xtable.

display

See documentation for xtable

nfirst

Only relevant for the multiSiena package.

...

Add extra parameters for print.xtable here. e.g. type, file.

Value

The function print.sienaFit prints a table containing estimated parameter values, standard errors and (optionally) t-statistics for convergence.

The function summary.sienaFit prints a table containing estimated parameter values, standard errors and t-statistics for convergence together with the covariance matrix of the estimates, the derivative matrix of expected statistics X by parameters, and the covariance matrix of the expected statistics X.

The function xtable.sienaFit creates an object of class xtable.sienaFit which inherits from class xtable and passes an extra arguments to the print.xtable.

The function siena.table outputs a latex or html table of the estimates and standards errors of a sienaFit object. The table will be written to a file in the current directory and has a footnote reporting the maximum of the convergence t-ratios. Endowment or creation effects will be denoted, respectively, by 'maintenance' or 'creation'.

See the manual for how to import the html tables easily into MS-Word.

Author(s)

Ruth Ripley, Charlotte Greenan, Tom Snijders

References

See https://www.stats.ox.ac.uk/~snijders/siena/

See Also

xtable, print.xtable, siena07

Examples

myalgorithm <- sienaAlgorithmCreate(nsub=2, n3=100, projname=NULL)
mynet1 <- sienaDependent(array(c(tmp3, tmp4), dim=c(32, 32, 2)))
mydata <- sienaDataCreate(mynet1)
myeff <- getEffects(mydata)
ans <- siena07(myalgorithm, data=mydata, effects=myeff, batch=TRUE)
ans
summary(ans)
## Not run: 
xtable(ans, type="html", file="ans.html")
siena.table(ans, type="html", tstat=TRUE, d=2)

## End(Not run)

RSiena documentation built on Nov. 2, 2023, 5:19 p.m.