writeDataFrame.AromaUnitTabularBinaryFile: Writes the data file as a tab-delimited text file

In aroma.core: Core Methods and Classes Used by 'aroma.*' Packages Part of the Aroma Framework

Writes the data file as a tab-delimited text file

Description

Writes the data file as a tab-delimited text file with or without file header comments.

Usage

## S3 method for class 'AromaUnitTabularBinaryFile'
writeDataFrame(this, filename=sprintf("%s.txt", getFilename(this)),
  path=file.path(getRootName(this, tags = "*,txt"), getFullName(this), getChipType(this,
  fullname = FALSE)), ..., columns=c("unitName", "*"), sep="\t", addHeader=TRUE,
  createdBy=NULL, nbrOfDecimals=4L, columnNamesPrefix=c("fullname", "name", "none"),
  overwrite=FALSE, verbose=FALSE)

Arguments

filename	The filename of generated file.
path	The path where the generated file should be written.
...	Not used.
columns	A character vector specifying which column names, including optional annotation data column names, that should be exported. A string "*" corresponds to inserting the column names of the source data file.
sep	A character string specifying the column separator

.

addHeader	If TRUE, file header comments will be added that contain additional information about the source file and more.
createdBy	A character string specifying the createdBy file header comment. If NULL, the package version will be written.
nbrOfDecimals	An integer specifying the number of decimals for floating point columns.
columnNamesPrefix	A character string specifying what type of prefix should be used for column names.
overwrite	If TRUE, an existing destination file will be overwritten, otherwise an exception will be thrown.
verbose	A logical or a Verbose object.

Value

Returns the write data file as a TabularTextFile object.

Author(s)

Henrik Bengtsson

See Also

For more information see AromaUnitTabularBinaryFile.

aroma.core documentation built on Nov. 16, 2022, 1:07 a.m.