R: Class "big.matrix.descriptor"

descriptor-class {bigmemory} | R Documentation

## Class "big.matrix.descriptor"

### Description

An object of this class contains necessary and sufficient information to “attach” a shared or filebacked `big.matrix`.

### Usage

    ## S4 method for signature 'big.matrix.descriptor'
    sub.big.matrix(
      x,
      firstRow = 1,
      lastRow = NULL,
      firstCol = 1,
      lastCol = NULL,
      backingpath = NULL
    )

    ## S4 method for signature 'character'
    attach.resource(obj, ...)

    ## S4 method for signature 'big.matrix.descriptor'
    attach.resource(obj, ...)

### Arguments

`x` | A descriptor object
`firstRow` | the first row of the submatrix
`lastRow` | the last row of the submatrix if not NULL
`firstCol` | the first column of the submatrix
`lastCol` | of the submatrix if not NULL
`backingpath` | required path to the filebacked object, if applicable
`obj` | The filename of the descriptor for a filebacked matrix, assumed to be in the directory specified
`...` | possibly `path` which gives the path where the descriptor and/or filebacking can be found.

### Objects from the Class

Objects should not be created by calls of the form `new("big.matrix.descriptor", ...)`, but should use the `describe` function.

### Slots

`description`:

  Object of class `"list"`; details omitted.

### Extends

Class `"descriptor"`, directly.

### Methods

attach.resource

  `signature(obj = "big.matrix.descriptor")`: ...

sub.big.matrix

  `signature(x = "big.matrix.descriptor")`: ...

### Note

We provide `attach.resource` for convenience, but expect most users will prefer `attach.big.matrix`.

### Author(s)

John W. Emerson and Michael J. Kane

### References

Other types of descriptors are defined in package synchronicity.

### See Also

See also `attach.big.matrix`.

### Examples

    showClass("big.matrix.descriptor")

[Package bigmemory version 4.5.36 Index]