Update doc fix #315 again [no ci] (#369)

gesistsa · Sep 13, 2023 · a0da5b9 · a0da5b9
1 parent 114a735
commit a0da5b9
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 28 deletions.
diff --git a/R/export.R b/R/export.R
@@ -13,9 +13,9 @@
 #' `export` supports many file formats. See the documentation for the underlying export functions for optional arguments that can be passed via `...`
 #'
 #' \itemize{
-#'     \item Comma-separated data (.csv), using [data.table::fwrite()] or, if `fwrite = TRUE`, [utils::write.table()] with `row.names = FALSE`.
-#'     \item Pipe-separated data (.psv), using [data.table::fwrite()] or, if `fwrite = TRUE`, [utils::write.table()] with `sep = '|'` and `row.names = FALSE`.
-#'     \item Tab-separated data (.tsv), using [data.table::fwrite()] or, if `fwrite = TRUE`, [utils::write.table()] with `row.names = FALSE`.
+#'     \item Comma-separated data (.csv), using [data.table::fwrite()]
+#'     \item Pipe-separated data (.psv), using [data.table::fwrite()]
+#'     \item Tab-separated data (.tsv), using [data.table::fwrite()]
 #'     \item SAS (.sas7bdat), using [haven::write_sas()].
 #'     \item SAS XPORT (.xpt), using [haven::write_xpt()].
 #'     \item SPSS (.sav), using [haven::write_sav()]

diff --git a/R/import.R b/R/import.R
@@ -17,14 +17,14 @@
 #' `import` supports the following file formats:
 #'
 #' \itemize{
-#'     \item Comma-separated data (.csv), using [data.table::fread()] or, if `fread = FALSE`, [utils::read.table()] with `row.names = FALSE` and `stringsAsFactors = FALSE`
-#'     \item Pipe-separated data (.psv), using [data.table::fread()] or, if `fread = FALSE`, [utils::read.table()] with `sep = '|'`, `row.names = FALSE` and `stringsAsFactors = FALSE`
-#'     \item Tab-separated data (.tsv), using [data.table::fread()] or, if `fread = FALSE`, [utils::read.table()] with `row.names = FALSE` and `stringsAsFactors = FALSE`
-#'     \item SAS (.sas7bdat), using [haven::read_sas()].
-#'     \item SAS XPORT (.xpt), using [haven::read_xpt()] or, if `haven = FALSE`, [foreign::read.xport()].
-#'     \item SPSS (.sav), using [haven::read_sav()]. If `haven = FALSE`, [foreign::read.spss()] can be used.
+#'     \item Comma-separated data (.csv), using [data.table::fread()]
+#'     \item Pipe-separated data (.psv), using [data.table::fread()]
+#'     \item Tab-separated data (.tsv), using [data.table::fread()]
+#'     \item SAS (.sas7bdat), using [haven::read_sas()]
+#'     \item SAS XPORT (.xpt), using [haven::read_xpt()]
+#'     \item SPSS (.sav), using [haven::read_sav()]
 #'     \item SPSS compressed (.zsav), using [haven::read_sav()].
-#'     \item Stata (.dta), using [haven::read_dta()]. If `haven = FALSE`, [foreign::read.dta()] can be used.
+#'     \item Stata (.dta), using [haven::read_dta()]
 #'     \item SPSS Portable Files (.por), using [haven::read_por()].
 #'     \item Excel (.xls and .xlsx), using [readxl::read_xlsx()] or [readxl::read_xls()]. Use `which` to specify a sheet number.
 #'     \item R syntax object (.R), using [base::dget()]
@@ -40,7 +40,7 @@
 #'     \item Weka Attribute-Relation File Format (.arff), using [foreign::read.arff()]
 #'     \item Data Interchange Format (.dif), using [utils::read.DIF()]
 #'     \item Fortran data (no recognized extension), using [utils::read.fortran()]
-#'     \item Fixed-width format data (.fwf), using a faster version of [utils::read.fwf()] that requires a `widths` argument and by default in rio has `stringsAsFactors = FALSE`. If `readr = TRUE`, import will be performed using [readr::read_fwf()], where `widths` should be: `NULL`, a vector of column widths, or the output of [readr::fwf_empty()], [readr::fwf_widths()], or [readr::fwf_positions()].
+#'     \item Fixed-width format data (.fwf), using a faster version of [utils::read.fwf()] that requires a `widths` argument and by default in rio has `stringsAsFactors = FALSE`
 #'     \item gzip comma-separated data (.csv.gz), using [utils::read.table()] with `row.names = FALSE` and `stringsAsFactors = FALSE`
 #'     \item [CSVY](https://github.com/csvy) (CSV with a YAML metadata header) using [data.table::fread()].
 #'     \item Apache Arrow Parquet (.parquet), using [arrow::read_parquet()]

diff --git a/R/sysdata.rda b/R/sysdata.rda
diff --git a/README.md b/README.md
@@ -135,13 +135,15 @@ The full list of supported formats is below:
 | Archive files (handled by tar)      | bzip2 / xz / tar      | utils          | utils          | Default |                         |
 | Gzip files                          | gz / gzip             | base           | base           | Default |                         |
 | Zip files                           | zip                   | utils          | utils          | Default |                         |
+| Apache Arrow (Parquet)              | parquet               | arrow          | arrow          | Default |                         |
 | CSVY (CSV + YAML metadata header)   | csvy                  | data.table     | data.table     | Default |                         |
 | Comma-separated data                | csv                   | data.table     | data.table     | Default |                         |
 | Comma-separated data (European)     | csv2                  | data.table     | data.table     | Default |                         |
 | Data Interchange Format             | dif                   | utils          |                | Default |                         |
 | Epiinfo                             | epiinfo / rec         | foreign        |                | Default |                         |
 | Excel                               | excel / xlsx          | readxl         | openxlsx       | Default |                         |
 | Excel (Legacy)                      | xls                   | readxl         |                | Default |                         |
+| Feather R/Python interchange format | feather               | arrow          | arrow          | Default |                         |
 | Fixed-width format data             | fwf                   | utils          | utils          | Default |                         |
 | Fortran data                        | fortran               | utils          |                | Default | No recognized extension |
 | Google Sheets                       | googlesheets          | data.table     |                | Default | As comma-separated data |
@@ -161,11 +163,9 @@ The full list of supported formats is below:
 | Text Representations of R Objects   | dump                  | base           | base           | Default |                         |
 | Weka Attribute-Relation File Format | arff / weka           | foreign        | foreign        | Default |                         |
 | XBASE database files                | dbf                   | foreign        | foreign        | Default |                         |
-| Apache Arrow (Parquet)              | parquet               | arrow          | arrow          | Suggest |                         |
 | Clipboard                           | clipboard             | clipr          | clipr          | Suggest | default is tsv          |
 | EViews                              | eviews / wf1          | hexView        |                | Suggest |                         |
 | Fast Storage                        | fst                   | fst            | fst            | Suggest |                         |
-| Feather R/Python interchange format | feather               | arrow          | arrow          | Suggest |                         |
 | Graphpad Prism                      | pzfx                  | pzfx           | pzfx           | Suggest |                         |
 | HTML Tables                         | htm / html            | xml2           | xml2           | Suggest |                         |
 | JSON                                | json                  | jsonlite       | jsonlite       | Suggest |                         |

diff --git a/data-raw/single.json b/data-raw/single.json
@@ -2,7 +2,7 @@
     {
         "input": "parquet",
         "format": "parquet",
-        "type": "suggest",
+        "type": "import",
         "format_name": "Apache Arrow (Parquet)",
         "import_function": "arrow::read_parquet",
         "export_function": "arrow::write_parquet",
@@ -209,7 +209,7 @@
     {
         "input": "feather",
         "format": "feather",
-        "type": "suggest",
+        "type": "import",
         "format_name": "Feather R/Python interchange format",
         "import_function": "arrow::read_feather",
         "export_function": "arrow::write_feather",

diff --git a/man/export.Rd b/man/export.Rd
diff --git a/man/import.Rd b/man/import.Rd
diff --git a/man/import_list.Rd b/man/import_list.Rd