sienaDataCreateFromSession: Creates a Siena data object from a Siena session file

Description Usage Arguments Details Value Author(s) References See Also Examples

Description

Reads in a Siena session from file and creates a Siena data or group object.

Usage

1
2
3
sienaDataCreateFromSession(filename = NULL,
    modelName = "Siena", edited = NULL, files = NULL,
    getDocumentation=FALSE)

Arguments

filename

Input session file

modelName

Character string of project name

edited

Boolean, indicates whether a file has been edited and therefore should not be re-read.

files

List of data files, used internally.

getDocumentation

Flag to allow documentation of internal functions, not for use by users.

Details

Allows creation of data objects of class "Siena" direct from data files rather than from the various Siena network and covariate objects. This remains from the earlier siena01gui.

The data file should have columns with exactly the names and in exactly the same order as those below with a row of column headings and no row numbers. No quotation marks needed.

Group

Used to identify the groups when using the multi-group option described in the Manual. Must not contain embedded blanks, and should be identical for all rows which relate to the same group.

Name

Names of dependent variables. Network files or dyadic covariates should use the same name for each file of the set. Other files should have unique names, a list of space separated ones for constant covariates.

Filename

Filenames.

Format

Only relevant for networks or dyadic covariates. Can be matrix, a single Pajek network (.net) or a Siena network file (and edgelist with three or four columns: from, to, value, wave (optional)). Not tested for dyadic covariates yet!

Period(s)

Only relevant for networks and dyadic covariates. All other files cover all the relevant periods. Indicates the order of the network and dyadic covariate files. Should range from 1 to n within each group. Enter multiple integers with spaces between for Siena network multi-wave files. Use the value 1 or blank for other files which cover multiple periods.

ActorSet

If you have more than one set of nodes, use this column to indicate which is relevant to each file. Should not contain embedded blanks.

Type

Indicate here what type of data the file contains. Options are "network", "behavior", "constant covariate", "changing covariate", "constant dyadic covariate", "changing dyadic covariate", "exogenous event".

Selected

Yes or No. Only files with Yes will be included in the model.

Missing Values

Enter any values which indicate missingness, with spaces between different entries.

Nonzero Codes

Enter any values which indicate ties, with spaces between different entries.

NbrOfActors

For Siena network files, enter the number of actors here.

If using a file for input, it should be of one of the following types:

Extension Type
.csv Comma separated
.dat or .prn Space delimited
.txt Tab delimited

Network and covariate files should be text files with a row for each node. The numbers should be separated by spaces or tabs. Exogenous events should be specified by a file with a row for each node. Each row should be consist of a set of pairs of numbers which indicate the periods during which the corresponding actor was present. e.g.

1
2
3
4
1 3
1.5 3
1 1.4 2.3 3
2.4 3

would describe a network with 4 nodes, and 3 observations. Actor 1 is present all the time, actor 2 joins at time 1.5, actor 3 leaves and time 1.4 then rejoins at time 2.3, actor 4 joins at time 2.4. All intervals are treated as closed.

Value

A list with the following components:

OK

Boolean, TRUE indicating success

mydata

A Siena data or group object, of class siena or sienaGroup

myeff

Effects object associated with mydata

Author(s)

Ruth Ripley

References

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

See Also

sienaDataCreate, siena

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## Not run: 
# Go to the directory that has the files needed here,
# but make sure to go back to the current directory at the end:
thiswd <- getwd()
# The directory where we want to go for the data files:
(pd <- system.file("examples", package="RSienaTest"))
setwd(pd)
# The file we need:
(filePath <- system.file("examples", "sienafreshman.csv", package="RSienaTest"))
session <- sienaDataCreateFromSession(filePath)
# In directory pd there are also other .csv files with accompanying data sets.
(mydata <- session$mydata)
(myeff <- session$myeff)
setwd(thiswd)

## End(Not run)

RSienaTest documentation built on July 14, 2021, 3 a.m.