aroma.core (version 3.1.1)

AromaTabularBinaryFile$allocate: Creates an AromaTabularBinaryFile

Description

Creates an AromaTabularBinaryFile of a certain dimension and data column types.

Usage

## Static method (use this):
## AromaTabularBinaryFile$allocate(filename, path=NULL, nbrOfRows, types, sizes,
##   signeds=TRUE, defaults=NA, comment=NULL, overwrite=FALSE, skip=FALSE, footer=list(),
##   ..., verbose=FALSE)
## Don't use the below:
# S3 method for AromaTabularBinaryFile
allocate(static, filename, path=NULL, nbrOfRows, types, sizes, signeds=TRUE, defaults=NA,
  comment=NULL, overwrite=FALSE, skip=FALSE, footer=list(), ..., verbose=FALSE)

Arguments

filename

The filename of the new file.

path

The path where to store the new file.

nbrOfRows

An integer specifying the number of rows to allocate.

types

A character vector specifying the data type of each column. The length specifies the number of columns to allocate.

sizes

An integer vector of values in {1,2,4,8} specifying the size of each column (data type).

signeds

An logical vector specifying if the data types in each column is signed or not.

defaults

An optional list (or vector) containing default values for each column.

comment

An optional character string written to the file header.

overwrite

If TRUE, an existing file is overwritten, otherwise not.

skip

If TRUE and overwrite=TRUE, any existing file is returned as is.

footer

An optional list of attributes written (as character strings) to the file footer.

...

Not used.

verbose

Verbose.

Value

Returns a AromaTabularBinaryFile object.

Data types

Valid data types are currently "integer" and "double".

See Also

For more information see AromaTabularBinaryFile.