write_tsv: TSV writer

In and3k/dtutils: Convenience Functions for the R Package data.table

Description

Writes an R object to a tab-separated values (TSV) file.

Usage

write_tsv(object, file, ...)

## S3 method for class 'data.table'
write_tsv(object, file, ...)

## S3 method for class 'data.frame'
write_tsv(object, file, row_names, ...)

## S3 method for class 'matrix'
write_tsv(object, file, row_names, col_names, ...)

Arguments

object	An R object to save as TSV.
file	Output file name. File extensions other than .tsv, .tab, and .txt result in a warning.
...	Additional arguments to be passed to methods (see below). All additional arguments in methods are ignored.
row_names	For R objects with row names. FALSE omits writing row names. TRUE writes row names. A single string can be given instead of TRUE to set the column name for the row names. Per default, row names are written, expect if they are automatic row names (i.e., numbered).
col_names	Analogous to row_names.

Methods (by class)

• data.table: Writes a data.table using data.table::fwrite().

• data.frame: Writes a data.frame using data.table::fwrite().

• matrix: Writes a matrix using data.table::fwrite().

Examples

library(dtutils)

# write a data.table
mtcars_dt <- data.table::as.data.table(mtcars, keep.rownames = TRUE)
write_tsv(mtcars_dt, "mtcars.tsv")

# write a data.frame
write_tsv(mtcars, "mtcars.tsv")
write_tsv(mtcars, "mtcars.tsv", row_names = "ROWNAMES")

# write a matrix
x <- matrix(runif(100), ncol = 5)
write_tsv(x, "matrix.tsv")
colnames(x) <- paste0("col_", letters[1:5])
write_tsv(x, "matrix_with_column_names.tsv")
rownames(x) <- paste0("row_", letters[1:20])
write_tsv(x, "matrix_with_column_and_row_names.tsv")

and3k/dtutils documentation built on April 25, 2020, 2:01 a.m.