1% Generated by roxygen2: do not edit by hand 2% Please edit documentation in R/csv.R, R/json.R 3\docType{class} 4\name{CsvReadOptions} 5\alias{CsvReadOptions} 6\alias{CsvParseOptions} 7\alias{CsvConvertOptions} 8\alias{JsonReadOptions} 9\alias{JsonParseOptions} 10\title{File reader options} 11\description{ 12\code{CsvReadOptions}, \code{CsvParseOptions}, \code{CsvConvertOptions}, 13\code{JsonReadOptions}, and \code{JsonParseOptions} are containers for various 14file reading options. See their usage in \code{\link[=read_csv_arrow]{read_csv_arrow()}} and 15\code{\link[=read_json_arrow]{read_json_arrow()}}, respectively. 16} 17\section{Factory}{ 18 19 20The \code{CsvReadOptions$create()} and \code{JsonReadOptions$create()} factory methods 21take the following arguments: 22\itemize{ 23\item \code{use_threads} Whether to use the global CPU thread pool 24\item \code{block_size} Block size we request from the IO layer; also determines 25the size of chunks when use_threads is \code{TRUE}. NB: if \code{FALSE}, JSON input 26must end with an empty line. 27} 28 29\code{CsvReadOptions$create()} further accepts these additional arguments: 30\itemize{ 31\item \code{skip_rows} Number of lines to skip before reading data (default 0) 32\item \code{column_names} Character vector to supply column names. If length-0 33(the default), the first non-skipped row will be parsed to generate column 34names, unless \code{autogenerate_column_names} is \code{TRUE}. 35\item \code{autogenerate_column_names} Logical: generate column names instead of 36using the first non-skipped row (the default)? If \code{TRUE}, column names will 37be "f0", "f1", ..., "fN". 38} 39 40\code{CsvParseOptions$create()} takes the following arguments: 41\itemize{ 42\item \code{delimiter} Field delimiting character (default \code{","}) 43\item \code{quoting} Logical: are strings quoted? (default \code{TRUE}) 44\item \code{quote_char} Quoting character, if \code{quoting} is \code{TRUE} 45\item \code{double_quote} Logical: are quotes inside values double-quoted? (default \code{TRUE}) 46\item \code{escaping} Logical: whether escaping is used (default \code{FALSE}) 47\item \code{escape_char} Escaping character, if \code{escaping} is \code{TRUE} 48\item \code{newlines_in_values} Logical: are values allowed to contain CR (\code{0x0d}) 49and LF (\code{0x0a}) characters? (default \code{FALSE}) 50\item \code{ignore_empty_lines} Logical: should empty lines be ignored (default) or 51generate a row of missing values (if \code{FALSE})? 52} 53 54\code{JsonParseOptions$create()} accepts only the \code{newlines_in_values} argument. 55 56\code{CsvConvertOptions$create()} takes the following arguments: 57\itemize{ 58\item \code{check_utf8} Logical: check UTF8 validity of string columns? (default \code{TRUE}) 59\item \code{null_values} character vector of recognized spellings for null values. 60Analogous to the \code{na.strings} argument to 61\code{\link[utils:read.csv]{read.csv()}} or \code{na} in \code{readr::read_csv()}. 62\item \code{strings_can_be_null} Logical: can string / binary columns have 63null values? Similar to the \code{quoted_na} argument to \code{readr::read_csv()}. 64(default \code{FALSE}) 65} 66} 67 68\section{Methods}{ 69 70 71These classes have no implemented methods. They are containers for the 72options. 73} 74 75