Learn R Programming

R.matlab (version 1.1.3)

writeMat: Writes a MAT file structure

Description

This function takes the given variables (...) and places them in a MAT file structure, which is then written to a binary connection. Currently only the MAT version 5 file format is supported.

Usage

## S3 method for class 'default}(con, ..., matVersion="5", onWrite=NULL, verbose=FALSE)':
writeMatundefined

con{Binary connection to which the MAT file structure should be
    written to. A string is interpreted as filename, which then will be
    opened (and closed afterwards).}
  ...{Named variables to be written.}
  matVersion{A character string specifying what MAT file format
    version to be written to the connection. If "5", a MAT v5 file
    structure is written. No other formats are currently supported.}
  onWrite{Function to be called just before starting to write to
    connection. Since the MAT file structure does not contain information
    about the total size of the structure this argument makes it possible
    to first write the structure size (in bytes) to the connection.}
  verbose{Either a logical, a numeric, or a Verbose
    object specifying how much verbose/debug information is written to
    standard output. If a Verbose object, how detailed the information is
    is specified by the threshold level of the object. If a numeric, the
    value is used to set the threshold of a new Verbose object. If TRUE,
    the threshold is set to -1 (minimal). If FALSE, no output is written
    (and neither is the R.utils package required).
  }

  Note that ... must not contain variables with names equal
  to the arguments matVersion and onWrite, which were choosen
  because we believe they are quite unique to this write method.

Returns (invisibly) the number of bytes written. Any bytes written by
  any onWrite function are not included in this count.

A <- matrix(1:27, ncol=3)
B <- as.matrix(1:10)

filename <- paste(tempfile(), ".mat", sep="")

writeMat(filename, A=A, B=B)
data <- readMat(filename)
print(data)

unlink(filename)

# When writing to a stream connection the receiver needs to know in
# beforehand how many bytes are available. This can be done by using
# the 'onWrite' argument.
onWrite <- function(x)
  writeBin(x$length, con=x$con, size=4, endian="little");
writeMat(con, A=A, B=B, onWrite=onWrite)

[object Object]

readMat().



file
IO

Arguments