From c65cfd28dc73f1dce6e72ec574af4d37998ef96d Mon Sep 17 00:00:00 2001 From: arunsrinivasan Date: Thu, 17 Dec 2015 12:17:40 +0100 Subject: [PATCH] Closes #1425. Fixed doc of skip argument in ?fread. --- README.md | 2 ++ man/fread.Rd | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f9c1bced30..7165161571 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,8 @@ 7. Better fix to `fread`'s `check.names` argument using `make.names()`, [#1027](https://github.com/Rdatatable/data.table/issues/1027). Thanks to @DavidArenberg for spotting the issue with the previous fix using `make.unique()`. + 8. Fixed explanation of `skip` argument in `?fread` as spotted by @aushev, [#1425](https://github.com/Rdatatable/data.table/issues/1425). + ### Changes in v1.9.6 (on CRAN 19 Sep 2015) #### NEW FEATURES diff --git a/man/fread.Rd b/man/fread.Rd index 75e2f26254..a4446c784b 100644 --- a/man/fread.Rd +++ b/man/fread.Rd @@ -30,7 +30,7 @@ data.table=getOption("datatable.fread.datatable") # default: TRUE \item{stringsAsFactors}{ Convert all character columns to factors? } \item{verbose}{ Be chatty and report timings? } \item{autostart}{ Any line number within the region of machine readable delimited text, by default 30. If the file is shorter or this line is empty (e.g. short files with trailing blank lines) then the last non empty line (with a non empty line above that) is used. This line and the lines above it are used to auto detect \code{sep}, \code{sep2} and the number of fields. It's extremely unlikely that \code{autostart} should ever need to be changed, we hope. } - \item{skip}{ If -1 (default) use the procedure described below starting on line \code{autostart} to find the first data row. \code{skip>=0} means ignore \code{autostart} and take line \code{skip+1} as the first data row (or column names according to header="auto"|TRUE|FALSE as usual). \code{skip="string"} searches for \code{"string"} in the file (e.g. a substring of the column names row) and starts on that line (inspired by read.xls in package gdata). } + \item{skip}{ If 0 (default) use the procedure described below starting on line \code{autostart} to find the first data row. \code{skip>0} means ignore \code{autostart} and take line \code{skip+1} as the first data row (or column names according to header="auto"|TRUE|FALSE as usual). \code{skip="string"} searches for \code{"string"} in the file (e.g. a substring of the column names row) and starts on that line (inspired by read.xls in package gdata). } \item{select}{ Vector of column names or numbers to keep, drop the rest. } \item{drop}{ Vector of column names or numbers to drop, keep the rest. } \item{colClasses}{ A character vector of classes (named or unnamed), as read.csv. Or a named list of vectors of column names or numbers, see examples. colClasses in fread is intended for rare overrides, not for routine use. fread will only promote a column to a higher type if colClasses requests it. It won't downgrade a column to a lower type since NAs would result. You have to coerce such columns afterwards yourself, if you really require data loss. }