CSVFile: Function for creating and initializing a CSVFile for...

View source: R/AllOldClasses.R

CSVFileR Documentation

Function for creating and initializing a CSVFile for publishing results

Description

A CSVFile is a pointer to a comma separated value file on the file system. Publishing to a CSVFile overwrites the current contents of the given CSVFile.

Usage

CSVFile(shortName, title = "", reportDirectory = ".")

Arguments

shortName

A character string giving a short title for the report. Used as the base of the filename.

reportDirectory

A character string giving the location of the report.

title

A character string giving a longer description of the report.

Value

An object of class CSVFile, which will represents a file to be written to. There are no open filehandles, and calling publish multiple times will result in the file being overwritten.

See Also

CSVFile-class, HTMLReport-class

Examples

my.df <- data.frame(EGID = c("103", "104", "105", "106", "107"),
                    RPKM = c(4, 5, 3, 100, 75),
                    DE = c("Yes", "Yes", "No", "No", "No"))
csv.file <- CSVFile(shortName = "my_csv_file",
    reportDirectory = "reportDirectory")
publish(my.df, csv.file)

JasonHackney/ReportingTools documentation built on Oct. 23, 2023, 9:24 p.m.