Matrix

An S4 class to represent a matrix. This is the mother class of all matrix objects.

Slots

id

A character string specifying the unique identifier of the matrix (UUID v4).

dates

A list giving the dates of each assemblage.

Note

Please note that all this class extends the R base matrix, but the S3 part of the object does not store the data.

Matrix ID

When a matrix is first created, an identifier is generated (UUID v4). This ID is preserved when coercing to another class. Thus, the object ID is unique within the same class, but two objects of different classes can have the same ID. This makes it possible to identify objects representing the same initial data and associate them with the results of specific computations.

Get and set

In the code snippets below, x is a *Matrix object.

get_id(x)

Get the ID of x.

get_dates(x) and set_dates(x) <- value

Get or set the dates of x.

Access

In the code snippets below, x is a *Matrix object.

length(x)

Returns the length of x.

dim(x)

Returns the dimension of x.

nrow(x)

Returns the number of rows present in x.

ncol(x)

Returns the number of columns present in x.

dimnames(x), dimnames(x) <- value

Retrieves or sets the row dimnames of x according to value.

rownames(x), rownames(x) <- value

Retrieves or sets the row names of x according to value.

colnames(x), colnames(x) <- value

Retrieves or sets the column names of x according to value.

Subset

In the code snippets below, x is a *Matrix object.

x[i, j, ..., drop]

Extracts elements selected by subscripts i and j. Indices are numeric or character vectors or empty (missing) or NULL. Numeric values are coerced to integer as by as.integer (and hence truncated towards zero). Character vectors will be matched to the dimnames of the object. An empty index (a comma separated blank) indicates that all entries in that dimension are selected. Returns an object of the same class as x.

x[[i]]

Extracts a single element selected by subscript i.

See also

Other matrix: AbundanceMatrix-class, CountMatrix-class, DataMatrix-class, IncidenceMatrix-class, OccurrenceMatrix-class, SimilarityMatrix-class, StratigraphicMatrix-class, coerce()

Author

N. Frerebeau