write_df: Write data.frames to File, using defaults typical for NONMEM...

Description Usage Arguments Details Author(s) Examples

View source: R/write_df.R

Description

This function is essencially a wrapper to write.table. I sets defaults to be more typical to the work done at BAST. Such that the output file should be a .csv file without quotes or row names. Additionally, when quote is FALSE it also checks the delimiter character is not found in any text strings. It can be set to replace these automatically with or without warnings.

Much of this help document is shamelessly copied and pasted from the write.table's documentation.

Usage

1
2
3
4
write_df(x, file = "", append = FALSE, quote = FALSE, sep = ",",
  rep = NULL, warn = TRUE, eol = "\n", na = "NA", dec = ".",
  row.names = FALSE, col.names = TRUE, qmethod = c("escape", "double"),
  fileEncoding = "", allowNAs = FALSE, allowEmptyCols = FALSE)

Arguments

x

the object to be written, preferably a matrix or data frame. If not, it is attempted to coerce x to a data frame

file

either a character string naming a file or a connection open for writing. "" indicates output to the console

append

logical. Only relevant if file is a character string. If TRUE, the output is appended to the file. If FALSE, any existing file of the name is destroyed.

quote

a logical value (TRUE or FALSE) or a numeric vector. If TRUE, any character or factor columns will be surrounded by double quotes. If a numeric vector, its elements are taken as the indices of columns to quote. In both cases, row and column names are quoted if they are written. If FALSE (default), nothing is quoted

sep

the field separator string. Values within each row of x are separated by this string. This has comma "," as default.

rep

is a replacement to be used when the separator character is found in one of the fields. If this is null then an error will be thrown if the seperator is found in a field.

warn

sets whether a warning is issued when replacements are made.

eol

the character(s) to print at the end of each line (row). For example, eol = "\r\n" will produce Windows' line endings on a Unix-alike OS, and eol = "\r" will produce files as expected by Excel:mac 2004.

na

the string to use for missing values in the data.

dec

the string to use for decimal points in numeric or complex columns: must be a single character.

row.names

either a logical value indicating whether the row names of x are to be written along with x, or a character vector of row names to be written.

col.names

either a logical value indicating whether the column names of x are to be written along with x, or a character vector of column names to be written. See the section on 'CSV files' for the meaning of col.names = NA.

qmethod

a character string specifying how to deal with embedded double quote characters when quoting strings. Must be one of "escape" (default for write.table), in which case the quote character is escaped in C style by a backslash, or "double" (default for write.csv and write.csv2), in which case it is doubled. You can specify just the initial letter.

fileEncoding

character string: if non-empty declares the encoding to be used on a file (not a connection) so the character data can be re-encoded as they are written. See file.

allowNAs

logical: if set to FALSE will throw a warning (regardless of warn) if any NAs are found in the data.

allowEmptyCols

logical: if set to FALSE will throw an error when a column is found to contain no data.

Details

see write.table for details

Author(s)

Aaron Hayman

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## Not run: 
randomString=function(n)
{
  l=as.integer(rlnorm(n)*3)
  #ind = rep(seq_along(l),l)
  r=sample(as.raw(44:127),sum(l),TRUE)
  char = readChar(r,l)
  return(char)
}
set.seed(100)
d=data.frame(a=1:100,b=sample(letters,100,TRUE),c=runif(100),d=TRUE,e=NaN,f='Blah, di, and blah',g=randomString(100),stringsAsFactors = TRUE)
df=data.frame(a=1:100,b=sample(letters,100,TRUE),c=runif(100),d=TRUE,e=NaN,f='Blah, di, and blah',g=randomString(100),stringsAsFactors = FALSE)

write_df(df,'d.csv',rep=';')

## End(Not run)

jgrevel/BAST1-R-Library documentation built on May 21, 2019, 10:11 a.m.