| <!DOCTYPE html> |
| <!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="A wrapper around open_dataset which explicitly includes parameters mirroring read_csv_arrow(), |
| read_delim_arrow(), and read_tsv_arrow() to allows for easy switching between functions |
| for opening single files and functions for opening datasets."><title>Open a multi-file dataset of CSV or other delimiter-separated format — open_delim_dataset • Arrow R Package</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><script src="../extra.js"></script><meta property="og:title" content="Open a multi-file dataset of CSV or other delimiter-separated format — open_delim_dataset"><meta property="og:description" content="A wrapper around open_dataset which explicitly includes parameters mirroring read_csv_arrow(), |
| read_delim_arrow(), and read_tsv_arrow() to allows for easy switching between functions |
| for opening single files and functions for opening datasets."><meta property="og:image" content="https://arrow.apache.org/img/arrow-logo_horizontal_black-txt_white-bg.png"><meta property="og:image:alt" content="Apache Arrow logo, displaying the triple chevron image adjacent to the text"><meta name="twitter:card" content="summary_large_image"><meta name="twitter:creator" content="@apachearrow"><meta name="twitter:site" content="@apachearrow"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
| <![endif]--><!-- Matomo --><script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '20']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script><!-- End Matomo Code --></head><body> |
| <a href="#main" class="visually-hidden-focusable">Skip to contents</a> |
| |
| |
| <nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-black"><div class="container"> |
| |
| <a class="navbar-brand me-2" href="../index.html">Arrow R Package</a> |
| |
| <span class="version"> |
| <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">11.0.0</small> |
| </span> |
| |
| |
| <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| |
| <div id="navbar" class="collapse navbar-collapse ms-3"> |
| <ul class="navbar-nav me-auto"><li class="nav-item"> |
| <a class="nav-link" href="../articles/arrow.html">Get started</a> |
| </li> |
| <li class="active nav-item"> |
| <a class="nav-link" href="../reference/index.html">Reference</a> |
| </li> |
| <li class="nav-item dropdown"> |
| <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown-articles">Articles</a> |
| <div class="dropdown-menu" aria-labelledby="dropdown-articles"> |
| <h6 class="dropdown-header" data-toc-skip>Using the package</h6> |
| <a class="dropdown-item" href="../articles/read_write.html">Reading and writing data files</a> |
| <a class="dropdown-item" href="../articles/data_wrangling.html">Data analysis with dplyr syntax</a> |
| <a class="dropdown-item" href="../articles/dataset.html">Working with multi-file data sets</a> |
| <a class="dropdown-item" href="../articles/python.html">Integrating Arrow, Python, and R</a> |
| <a class="dropdown-item" href="../articles/fs.html">Using cloud storage (S3, GCS)</a> |
| <a class="dropdown-item" href="../articles/flight.html">Connecting to a Flight server</a> |
| <div class="dropdown-divider"></div> |
| <h6 class="dropdown-header" data-toc-skip>Arrow concepts</h6> |
| <a class="dropdown-item" href="../articles/data_objects.html">Data objects</a> |
| <a class="dropdown-item" href="../articles/data_types.html">Data types</a> |
| <a class="dropdown-item" href="../articles/metadata.html">Metadata</a> |
| <div class="dropdown-divider"></div> |
| <h6 class="dropdown-header" data-toc-skip>Installation</h6> |
| <a class="dropdown-item" href="../articles/install.html">Installing on Linux</a> |
| <a class="dropdown-item" href="../articles/install_nightly.html">Installing development versions</a> |
| <div class="dropdown-divider"></div> |
| <a class="dropdown-item" href="../articles/index.html">More articles...</a> |
| </div> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="../news/index.html">Changelog</a> |
| </li> |
| </ul><form class="form-inline my-2 my-lg-0" role="search"> |
| <input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form> |
| |
| <ul class="navbar-nav"></ul></div> |
| |
| |
| </div> |
| </nav><div class="container template-reference-topic"> |
| <div class="row"> |
| <main id="main" class="col-md-9"><div class="page-header"> |
| <img src="" class="logo" alt=""><h1>Open a multi-file dataset of CSV or other delimiter-separated format</h1> |
| <small class="dont-index">Source: <a href="https://github.com/apache/arrow/blob/master/r/R/dataset.R" class="external-link"><code>R/dataset.R</code></a></small> |
| <div class="d-none name"><code>open_delim_dataset.Rd</code></div> |
| </div> |
| |
| <div class="ref-description section level2"> |
| <p>A wrapper around <a href="open_dataset.html">open_dataset</a> which explicitly includes parameters mirroring <code><a href="read_delim_arrow.html">read_csv_arrow()</a></code>, |
| <code><a href="read_delim_arrow.html">read_delim_arrow()</a></code>, and <code><a href="read_delim_arrow.html">read_tsv_arrow()</a></code> to allows for easy switching between functions |
| for opening single files and functions for opening datasets.</p> |
| </div> |
| |
| <div class="section level2"> |
| <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2> |
| <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">open_delim_dataset</span><span class="op">(</span></span> |
| <span> <span class="va">sources</span>,</span> |
| <span> schema <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> partitioning <span class="op">=</span> <span class="fu"><a href="hive_partition.html">hive_partition</a></span><span class="op">(</span><span class="op">)</span>,</span> |
| <span> hive_style <span class="op">=</span> <span class="cn">NA</span>,</span> |
| <span> unify_schemas <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> factory_options <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span>,</span> |
| <span> delim <span class="op">=</span> <span class="st">","</span>,</span> |
| <span> quote <span class="op">=</span> <span class="st">"\""</span>,</span> |
| <span> escape_double <span class="op">=</span> <span class="cn">TRUE</span>,</span> |
| <span> escape_backslash <span class="op">=</span> <span class="cn">FALSE</span>,</span> |
| <span> col_names <span class="op">=</span> <span class="cn">TRUE</span>,</span> |
| <span> col_types <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> na <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">""</span>, <span class="st">"NA"</span><span class="op">)</span>,</span> |
| <span> skip_empty_rows <span class="op">=</span> <span class="cn">TRUE</span>,</span> |
| <span> skip <span class="op">=</span> <span class="fl">0L</span>,</span> |
| <span> convert_options <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> read_options <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> timestamp_parsers <span class="op">=</span> <span class="cn">NULL</span></span> |
| <span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">open_csv_dataset</span><span class="op">(</span></span> |
| <span> <span class="va">sources</span>,</span> |
| <span> schema <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> partitioning <span class="op">=</span> <span class="fu"><a href="hive_partition.html">hive_partition</a></span><span class="op">(</span><span class="op">)</span>,</span> |
| <span> hive_style <span class="op">=</span> <span class="cn">NA</span>,</span> |
| <span> unify_schemas <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> factory_options <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span>,</span> |
| <span> quote <span class="op">=</span> <span class="st">"\""</span>,</span> |
| <span> escape_double <span class="op">=</span> <span class="cn">TRUE</span>,</span> |
| <span> escape_backslash <span class="op">=</span> <span class="cn">FALSE</span>,</span> |
| <span> col_names <span class="op">=</span> <span class="cn">TRUE</span>,</span> |
| <span> col_types <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> na <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">""</span>, <span class="st">"NA"</span><span class="op">)</span>,</span> |
| <span> skip_empty_rows <span class="op">=</span> <span class="cn">TRUE</span>,</span> |
| <span> skip <span class="op">=</span> <span class="fl">0L</span>,</span> |
| <span> convert_options <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> read_options <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> timestamp_parsers <span class="op">=</span> <span class="cn">NULL</span></span> |
| <span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">open_tsv_dataset</span><span class="op">(</span></span> |
| <span> <span class="va">sources</span>,</span> |
| <span> schema <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> partitioning <span class="op">=</span> <span class="fu"><a href="hive_partition.html">hive_partition</a></span><span class="op">(</span><span class="op">)</span>,</span> |
| <span> hive_style <span class="op">=</span> <span class="cn">NA</span>,</span> |
| <span> unify_schemas <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> factory_options <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span>,</span> |
| <span> quote <span class="op">=</span> <span class="st">"\""</span>,</span> |
| <span> escape_double <span class="op">=</span> <span class="cn">TRUE</span>,</span> |
| <span> escape_backslash <span class="op">=</span> <span class="cn">FALSE</span>,</span> |
| <span> col_names <span class="op">=</span> <span class="cn">TRUE</span>,</span> |
| <span> col_types <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> na <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">""</span>, <span class="st">"NA"</span><span class="op">)</span>,</span> |
| <span> skip_empty_rows <span class="op">=</span> <span class="cn">TRUE</span>,</span> |
| <span> skip <span class="op">=</span> <span class="fl">0L</span>,</span> |
| <span> convert_options <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> read_options <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> timestamp_parsers <span class="op">=</span> <span class="cn">NULL</span></span> |
| <span><span class="op">)</span></span></code></pre></div> |
| </div> |
| |
| <div class="section level2"> |
| <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2> |
| <dl><dt>sources</dt> |
| <dd><p>One of:</p><ul><li><p>a string path or URI to a directory containing data files</p></li> |
| <li><p>a <a href="FileSystem.html">FileSystem</a> that references a directory containing data files |
| (such as what is returned by <code><a href="s3_bucket.html">s3_bucket()</a></code>)</p></li> |
| <li><p>a string path or URI to a single file</p></li> |
| <li><p>a character vector of paths or URIs to individual data files</p></li> |
| <li><p>a list of <code>Dataset</code> objects as created by this function</p></li> |
| <li><p>a list of <code>DatasetFactory</code> objects as created by <code><a href="dataset_factory.html">dataset_factory()</a></code>.</p></li> |
| </ul><p>When <code>sources</code> is a vector of file URIs, they must all use the same protocol |
| and point to files located in the same file system and having the same |
| format.</p></dd> |
| |
| |
| <dt>schema</dt> |
| <dd><p><a href="Schema.html">Schema</a> for the <code>Dataset</code>. If <code>NULL</code> (the default), the schema |
| will be inferred from the data sources.</p></dd> |
| |
| |
| <dt>partitioning</dt> |
| <dd><p>When <code>sources</code> is a directory path/URI, one of:</p><ul><li><p>a <code>Schema</code>, in which case the file paths relative to <code>sources</code> will be |
| parsed, and path segments will be matched with the schema fields.</p></li> |
| <li><p>a character vector that defines the field names corresponding to those |
| path segments (that is, you're providing the names that would correspond |
| to a <code>Schema</code> but the types will be autodetected)</p></li> |
| <li><p>a <code>Partitioning</code> or <code>PartitioningFactory</code>, such as returned |
| by <code><a href="hive_partition.html">hive_partition()</a></code></p></li> |
| <li><p><code>NULL</code> for no partitioning</p></li> |
| </ul><p>The default is to autodetect Hive-style partitions unless |
| <code>hive_style = FALSE</code>. See the "Partitioning" section for details. |
| When <code>sources</code> is not a directory path/URI, <code>partitioning</code> is ignored.</p></dd> |
| |
| |
| <dt>hive_style</dt> |
| <dd><p>Logical: should <code>partitioning</code> be interpreted as |
| Hive-style? Default is <code>NA</code>, which means to inspect the file paths for |
| Hive-style partitioning and behave accordingly.</p></dd> |
| |
| |
| <dt>unify_schemas</dt> |
| <dd><p>logical: should all data fragments (files, <code>Dataset</code>s) |
| be scanned in order to create a unified schema from them? If <code>FALSE</code>, only |
| the first fragment will be inspected for its schema. Use this fast path |
| when you know and trust that all fragments have an identical schema. |
| The default is <code>FALSE</code> when creating a dataset from a directory path/URI or |
| vector of file paths/URIs (because there may be many files and scanning may |
| be slow) but <code>TRUE</code> when <code>sources</code> is a list of <code>Dataset</code>s (because there |
| should be few <code>Dataset</code>s in the list and their <code>Schema</code>s are already in |
| memory).</p></dd> |
| |
| |
| <dt>factory_options</dt> |
| <dd><p>list of optional FileSystemFactoryOptions:</p><ul><li><p><code>partition_base_dir</code>: string path segment prefix to ignore when |
| discovering partition information with DirectoryPartitioning. Not |
| meaningful (ignored with a warning) for HivePartitioning, nor is it |
| valid when providing a vector of file paths.</p></li> |
| <li><p><code>exclude_invalid_files</code>: logical: should files that are not valid data |
| files be excluded? Default is <code>FALSE</code> because checking all files up |
| front incurs I/O and thus will be slower, especially on remote |
| filesystems. If false and there are invalid files, there will be an |
| error at scan time. This is the only FileSystemFactoryOption that is |
| valid for both when providing a directory path in which to discover |
| files and when providing a vector of file paths.</p></li> |
| <li><p><code>selector_ignore_prefixes</code>: character vector of file prefixes to ignore |
| when discovering files in a directory. If invalid files can be excluded |
| by a common filename prefix this way, you can avoid the I/O cost of |
| <code>exclude_invalid_files</code>. Not valid when providing a vector of file paths |
| (but if you're providing the file list, you can filter invalid files |
| yourself).</p></li> |
| </ul></dd> |
| |
| |
| <dt>delim</dt> |
| <dd><p>Single character used to separate fields within a record.</p></dd> |
| |
| |
| <dt>quote</dt> |
| <dd><p>Single character used to quote strings.</p></dd> |
| |
| |
| <dt>escape_double</dt> |
| <dd><p>Does the file escape quotes by doubling them? |
| i.e. If this option is <code>TRUE</code>, the value <code>""""</code> represents |
| a single quote, <code>\"</code>.</p></dd> |
| |
| |
| <dt>escape_backslash</dt> |
| <dd><p>Does the file use backslashes to escape special |
| characters? This is more general than <code>escape_double</code> as backslashes |
| can be used to escape the delimiter character, the quote character, or |
| to add special characters like <code>\\n</code>.</p></dd> |
| |
| |
| <dt>col_names</dt> |
| <dd><p>If <code>TRUE</code>, the first row of the input will be used as the |
| column names and will not be included in the data frame. If <code>FALSE</code>, column |
| names will be generated by Arrow, starting with "f0", "f1", ..., "fN". |
| Alternatively, you can specify a character vector of column names.</p></dd> |
| |
| |
| <dt>col_types</dt> |
| <dd><p>A compact string representation of the column types, |
| an Arrow <a href="Schema.html">Schema</a>, or <code>NULL</code> (the default) to infer types from the data.</p></dd> |
| |
| |
| <dt>na</dt> |
| <dd><p>A character vector of strings to interpret as missing values.</p></dd> |
| |
| |
| <dt>skip_empty_rows</dt> |
| <dd><p>Should blank rows be ignored altogether? If |
| <code>TRUE</code>, blank rows will not be represented at all. If <code>FALSE</code>, they will be |
| filled with missings.</p></dd> |
| |
| |
| <dt>skip</dt> |
| <dd><p>Number of lines to skip before reading data.</p></dd> |
| |
| |
| <dt>convert_options</dt> |
| <dd><p>see <a href="CsvReadOptions.html">file reader options</a></p></dd> |
| |
| |
| <dt>read_options</dt> |
| <dd><p>see <a href="CsvReadOptions.html">file reader options</a></p></dd> |
| |
| |
| <dt>timestamp_parsers</dt> |
| <dd><p>User-defined timestamp parsers. If more than one |
| parser is specified, the CSV conversion logic will try parsing values |
| starting from the beginning of this vector. Possible values are:</p><ul><li><p><code>NULL</code>: the default, which uses the ISO-8601 parser</p></li> |
| <li><p>a character vector of <a href="https://rdrr.io/r/base/strptime.html" class="external-link">strptime</a> parse strings</p></li> |
| <li><p>a list of <a href="CsvReadOptions.html">TimestampParser</a> objects</p></li> |
| </ul></dd> |
| |
| </dl></div> |
| <div class="section level2"> |
| <h2 id="options-currently-supported-by-read-delim-arrow-which-are-not-supported-here">Options currently supported by <code><a href="read_delim_arrow.html">read_delim_arrow()</a></code> which are not supported here<a class="anchor" aria-label="anchor" href="#options-currently-supported-by-read-delim-arrow-which-are-not-supported-here"></a></h2> |
| |
| |
| <ul><li><p><code>file</code> (instead, please specify files in <code>sources</code>)</p></li> |
| <li><p><code>col_select</code> (instead, subset columns after dataset creation)</p></li> |
| <li><p><code>quoted_na</code></p></li> |
| <li><p><code>as_data_frame</code> (instead, convert to data frame after dataset creation)</p></li> |
| <li><p><code>parse_options</code></p></li> |
| </ul></div> |
| <div class="section level2"> |
| <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2> |
| <div class="dont-index"><p><code><a href="open_dataset.html">open_dataset()</a></code></p></div> |
| </div> |
| |
| <div class="section level2"> |
| <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2> |
| <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># Set up directory for examples</span></span></span> |
| <span class="r-in"><span><span class="va">tf</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span><span class="op">)</span></span></span> |
| <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/files2.html" class="external-link">dir.create</a></span><span class="op">(</span><span class="va">tf</span><span class="op">)</span></span></span> |
| <span class="r-in"><span><span class="va">df</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>x <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"1"</span>, <span class="st">"2"</span>, <span class="st">"NULL"</span><span class="op">)</span><span class="op">)</span></span></span> |
| <span class="r-in"><span></span></span> |
| <span class="r-in"><span><span class="va">file_path</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">tf</span>, <span class="st">"file1.txt"</span><span class="op">)</span></span></span> |
| <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/write.table.html" class="external-link">write.table</a></span><span class="op">(</span><span class="va">df</span>, <span class="va">file_path</span>, sep <span class="op">=</span> <span class="st">","</span>, row.names <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></span> |
| <span class="r-in"><span></span></span> |
| <span class="r-in"><span><span class="fu"><a href="read_delim_arrow.html">read_csv_arrow</a></span><span class="op">(</span><span class="va">file_path</span>, na <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">""</span>, <span class="st">"NA"</span>, <span class="st">"NULL"</span><span class="op">)</span>, col_names <span class="op">=</span> <span class="st">"y"</span>, skip <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># A tibble: 3 x 1</span></span> |
| <span class="r-out co"><span class="r-pr">#></span> y</span> |
| <span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494; font-style: italic;"><int></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">1</span> 1</span> |
| <span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">2</span> 2</span> |
| <span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">3</span> <span style="color: #BB0000;">NA</span></span> |
| <span class="r-in"><span><span class="fu">open_csv_dataset</span><span class="op">(</span><span class="va">file_path</span>, na <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">""</span>, <span class="st">"NA"</span>, <span class="st">"NULL"</span><span class="op">)</span>, col_names <span class="op">=</span> <span class="st">"y"</span>, skip <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> FileSystemDataset with 1 csv file</span> |
| <span class="r-out co"><span class="r-pr">#></span> y: int64</span> |
| <span class="r-in"><span></span></span> |
| <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">tf</span><span class="op">)</span></span></span> |
| </code></pre></div> |
| </div> |
| </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2> |
| </nav></aside></div> |
| |
| |
| <footer><div class="pkgdown-footer-left"> |
| <p></p><p><a href="https://arrow.apache.org/docs/r/versions.html">Older versions of these docs</a></p> |
| </div> |
| |
| <div class="pkgdown-footer-right"> |
| <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> |
| </div> |
| |
| </footer></div> |
| |
| |
| |
| |
| |
| </body></html> |
| |