summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/make_readable_file.Rd
blob: fe2e29826120d1bdc69636dcf14d56fe52645617 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/io.R
\name{make_readable_file}
\alias{make_readable_file}
\title{Handle a range of possible input sources}
\usage{
make_readable_file(file, mmap = TRUE, compression = NULL, filesystem = NULL)
}
\arguments{
\item{file}{A character file name, \code{raw} vector, or an Arrow input stream}

\item{mmap}{Logical: whether to memory-map the file (default \code{TRUE})}

\item{compression}{If the file is compressed, created a \link{CompressedInputStream}
with this compression codec, either a \link{Codec} or the string name of one.
If \code{NULL} (default) and \code{file} is a string file name, the function will try
to infer compression from the file extension.}

\item{filesystem}{If not \code{NULL}, \code{file} will be opened via the
\code{filesystem$OpenInputFile()} filesystem method, rather than the \code{io} module's
\code{MemoryMappedFile} or \code{ReadableFile} constructors.}
}
\value{
An \code{InputStream} or a subclass of one.
}
\description{
Handle a range of possible input sources
}
\keyword{internal}