Add note about writing now

jimhester · Apr 18, 2019 · 1b2cf97 · 1b2cf97
1 parent f3d1a41
commit 1b2cf97
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 28 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -55,8 +55,8 @@ each record is located so it can be read later. The vectors returned use the
 lazily load the data on-demand when it is accessed, so you only pay for what
 you use.
 
-vroom also uses multiple threads for indexing and materializing non-character
-columns, to further improve performance.
+vroom also uses multiple threads for indexing, materializing non-character
+columns, and when writing to further improve performance.
 
 ```{r, echo = FALSE}
 knitr::kable(tbl, digits = 2, align = "lrrrr")
@@ -82,6 +82,7 @@ vroom has nearly all of the parsing features of
 - windows newlines
 - [reading from multiple files or connections\*](#reading-multiple-files)
 - embedded newlines in headers and fields\*\*
+- writing delimited files with as-needed quoting.
 
 \* *these are additional features only in vroom.*
 
@@ -153,17 +154,6 @@ for full details of the dataset and
 [bench/](https://github.com/jimhester/vroom/blob/master/inst/bench) for the code
 used to retrieve the data and perform the benchmarks.
 
-## RStudio caveats
-
-RStudio's environment pane auto-refresh behavior calls `object.size()` which for Altrep
-objects can be extremely slow. This was fixed in
-[rstudio#4210](https://github.com/rstudio/rstudio/pull/4210) and [rstudio#4292](https://github.com/rstudio/rstudio/pull/4292), so it is
-recommended you use a [daily version](https://dailies.rstudio.com/) if you are
-trying to use vroom inside RStudio. For older versions a workaround is to
-use the 'Manual Refresh Only' option in the environment pane.
-
-![](https://user-images.githubusercontent.com/470418/51357022-95a1f280-1a82-11e9-8035-3687c8fd5dd8.png)
-
 # Environment variables
 
 In addition to the arguments to the `vroom()` function, you can control the
@@ -205,6 +195,17 @@ There are also individual variables for each type. Currently only
 - `VROOM_USE_ALTREP_DATE`
 - `VROOM_USE_ALTREP_TIME`
 
+## RStudio caveats
+
+RStudio's environment pane auto-refresh behavior calls `object.size()` which for Altrep
+objects can be extremely slow. This was fixed in
+[rstudio#4210](https://github.com/rstudio/rstudio/pull/4210) and [rstudio#4292](https://github.com/rstudio/rstudio/pull/4292), so it is
+recommended you use a [daily version](https://dailies.rstudio.com/) if you are
+trying to use vroom inside RStudio. For older versions a workaround is to
+use the 'Manual Refresh Only' option in the environment pane.
+
+![](https://user-images.githubusercontent.com/470418/51357022-95a1f280-1a82-11e9-8035-3687c8fd5dd8.png)
+
 ## Thanks
 
 - [Gabe Becker](https://twitter.com/groundwalkergmb), [Luke

diff --git a/README.md b/README.md
@@ -29,8 +29,8 @@ framework](https://svn.r-project.org/R/branches/ALTREP/ALTREP.html) to
 lazily load the data on-demand when it is accessed, so you only pay for
 what you use.
 
-vroom also uses multiple threads for indexing and materializing
-non-character columns, to further improve performance.
+vroom also uses multiple threads for indexing, materializing
+non-character columns, and when writing to further improve performance.
 
 | package    |    version | time (sec) | speedup | throughput |
 | :--------- | ---------: | ---------: | ------: | ---------: |
@@ -61,6 +61,7 @@ files, including
   - [reading from multiple files or
     connections\*](#reading-multiple-files)
   - embedded newlines in headers and fields\*\*
+  - writing delimited files with as-needed quoting.
 
 \* *these are additional features only in vroom.*
 
@@ -155,19 +156,6 @@ for full details of the dataset and
 [bench/](https://github.com/jimhester/vroom/blob/master/inst/bench) for
 the code used to retrieve the data and perform the benchmarks.
 
-## RStudio caveats
-
-RStudio’s environment pane auto-refresh behavior calls `object.size()`
-which for Altrep objects can be extremely slow. This was fixed in
-[rstudio\#4210](https://github.com/rstudio/rstudio/pull/4210) and
-[rstudio\#4292](https://github.com/rstudio/rstudio/pull/4292), so it is
-recommended you use a [daily version](https://dailies.rstudio.com/) if
-you are trying to use vroom inside RStudio. For older versions a
-workaround is to use the ‘Manual Refresh Only’ option in the environment
-pane.
-
-![](https://user-images.githubusercontent.com/470418/51357022-95a1f280-1a82-11e9-8035-3687c8fd5dd8.png)
-
 # Environment variables
 
 In addition to the arguments to the `vroom()` function, you can control
@@ -211,6 +199,19 @@ There are also individual variables for each type. Currently only
   - `VROOM_USE_ALTREP_DATE`
   - `VROOM_USE_ALTREP_TIME`
 
+## RStudio caveats
+
+RStudio’s environment pane auto-refresh behavior calls `object.size()`
+which for Altrep objects can be extremely slow. This was fixed in
+[rstudio\#4210](https://github.com/rstudio/rstudio/pull/4210) and
+[rstudio\#4292](https://github.com/rstudio/rstudio/pull/4292), so it is
+recommended you use a [daily version](https://dailies.rstudio.com/) if
+you are trying to use vroom inside RStudio. For older versions a
+workaround is to use the ‘Manual Refresh Only’ option in the environment
+pane.
+
+![](https://user-images.githubusercontent.com/470418/51357022-95a1f280-1a82-11e9-8035-3687c8fd5dd8.png)
+
 ## Thanks
 
   - [Gabe Becker](https://twitter.com/groundwalkergmb), [Luke