From 6b64f4c19fcf802e903a2ed34fa501e27bb1e063 Mon Sep 17 00:00:00 2001 From: JanMarvin Date: Sun, 11 Feb 2024 20:48:46 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20JanMarvi?= =?UTF-8?q?n/openxlsx2@566dfa0f711fdee37c075f2c4ba826baad184c92=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev/pkgdown.yml | 2 +- dev/reference/properties-wb.html | 2 +- dev/reference/wb_add_data.html | 18 +++++++++++++++-- dev/reference/wb_add_data_table.html | 29 +++++++++++++++++++++++----- dev/reference/write_datatable.html | 29 +++++++++++++++++++++++----- dev/search.json | 2 +- 6 files changed, 67 insertions(+), 15 deletions(-) diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index dc2f32815..91d934c41 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -8,7 +8,7 @@ articles: openxlsx2_charts_manual: openxlsx2_charts_manual.html openxlsx2_formulas_manual: openxlsx2_formulas_manual.html openxlsx2_style_manual: openxlsx2_style_manual.html -last_built: 2024-02-11T13:42Z +last_built: 2024-02-11T20:47Z urls: reference: https://janmarvin.github.io/openxlsx2/reference article: https://janmarvin.github.io/openxlsx2/articles diff --git a/dev/reference/properties-wb.html b/dev/reference/properties-wb.html index d9f956061..0c09f00dd 100644 --- a/dev/reference/properties-wb.html +++ b/dev/reference/properties-wb.html @@ -147,7 +147,7 @@

Exampleswb$set_properties(title = "my title") wb$get_properties() #> creator modifier datetime_created -#> "Jan Marvin Garbuszus" "Jan Marvin Garbuszus" "2024-02-11T13:42:40Z" +#> "Jan Marvin Garbuszus" "Jan Marvin Garbuszus" "2024-02-11T20:47:55Z" #> datetime_modified title company #> "2023-05-29T10:47:37Z" "my title" "" diff --git a/dev/reference/wb_add_data.html b/dev/reference/wb_add_data.html index 412a3f67c..48c0274fd 100644 --- a/dev/reference/wb_add_data.html +++ b/dev/reference/wb_add_data.html @@ -170,12 +170,26 @@

Detailsread_xlsx(). This is because only the formula is written and left to Excel to evaluate the formula when the file is opened in Excel. The string "_openxlsx_NA" is reserved for openxlsx2. -If the data frame contains this string, the output will be broken. -Many base classes are covered, though not all and far from all third-party classes. +If the data frame contains this string, the output will be broken.

+

Supported classes are data frames, matrices and vectors of various types and +everything that can be converted into a data frame with as.data.frame(). +Everything else that the user wants to write should either be converted into +a vector or data frame or written in vector or data frame segments. This +includes base classes such as table, which were coerced internally in the +predecessor of this package.

+

Even vectors and data frames can consist of different classes. Many base +classes are covered, though not all and far from all third-party classes. When data of an unknown class is written, it is handled with as.character(). It is not possible to write character nodes beginning with <r> or <r/>. Both are reserved for internal functions. If you need these. You have to wrap the input string in fmt_txt().

+

The columns of x with class Date/POSIXt, currency, accounting, hyperlink, +percentage are automatically styled as dates, currency, accounting, +hyperlinks, percentages respectively.

+

Functions wb_add_data() and wb_add_data_table() behave quite similar. The +distinction is that the latter creates a table in the worksheet that can be +used for different kind of formulas and can be sorted independently, though +is less flexible than basic cell regions.

See also

diff --git a/dev/reference/wb_add_data_table.html b/dev/reference/wb_add_data_table.html index 1114aa361..4dc7ce688 100644 --- a/dev/reference/wb_add_data_table.html +++ b/dev/reference/wb_add_data_table.html @@ -182,11 +182,30 @@

Arguments

Details

-

The columns of x with class Date/POSIXt, currency, accounting, hyperlink, -percentage are automatically styled as dates, currency, accounting, hyperlinks, -percentages respectively.

-

The string "_openxlsx_NA" is reserved for openxlsx2. If x contains this -string, the output will be broken.

+

Formulae written using wb_add_formula() to a Workbook object will +not get picked up by read_xlsx(). This is because only the formula is written +and left to Excel to evaluate the formula when the file is opened in Excel. +The string "_openxlsx_NA" is reserved for openxlsx2. +If the data frame contains this string, the output will be broken.

+

Supported classes are data frames, matrices and vectors of various types and +everything that can be converted into a data frame with as.data.frame(). +Everything else that the user wants to write should either be converted into +a vector or data frame or written in vector or data frame segments. This +includes base classes such as table, which were coerced internally in the +predecessor of this package.

+

Even vectors and data frames can consist of different classes. Many base +classes are covered, though not all and far from all third-party classes. +When data of an unknown class is written, it is handled with as.character(). +It is not possible to write character nodes beginning with <r> or <r/>. Both +are reserved for internal functions. If you need these. You have to wrap +the input string in fmt_txt().

+

The columns of x with class Date/POSIXt, currency, accounting, hyperlink, +percentage are automatically styled as dates, currency, accounting, +hyperlinks, percentages respectively.

+

Functions wb_add_data() and wb_add_data_table() behave quite similar. The +distinction is that the latter creates a table in the worksheet that can be +used for different kind of formulas and can be sorted independently, though +is less flexible than basic cell regions.

See also

diff --git a/dev/reference/write_datatable.html b/dev/reference/write_datatable.html index 4c672736c..5792992fa 100644 --- a/dev/reference/write_datatable.html +++ b/dev/reference/write_datatable.html @@ -185,11 +185,30 @@

Arguments

Details

-

The columns of x with class Date/POSIXt, currency, accounting, hyperlink, -percentage are automatically styled as dates, currency, accounting, hyperlinks, -percentages respectively.

-

The string "_openxlsx_NA" is reserved for openxlsx2. If x contains this -string, the output will be broken.

+

Formulae written using wb_add_formula() to a Workbook object will +not get picked up by read_xlsx(). This is because only the formula is written +and left to Excel to evaluate the formula when the file is opened in Excel. +The string "_openxlsx_NA" is reserved for openxlsx2. +If the data frame contains this string, the output will be broken.

+

Supported classes are data frames, matrices and vectors of various types and +everything that can be converted into a data frame with as.data.frame(). +Everything else that the user wants to write should either be converted into +a vector or data frame or written in vector or data frame segments. This +includes base classes such as table, which were coerced internally in the +predecessor of this package.

+

Even vectors and data frames can consist of different classes. Many base +classes are covered, though not all and far from all third-party classes. +When data of an unknown class is written, it is handled with as.character(). +It is not possible to write character nodes beginning with <r> or <r/>. Both +are reserved for internal functions. If you need these. You have to wrap +the input string in fmt_txt().

+

The columns of x with class Date/POSIXt, currency, accounting, hyperlink, +percentage are automatically styled as dates, currency, accounting, +hyperlinks, percentages respectively.

+

Functions wb_add_data() and wb_add_data_table() behave quite similar. The +distinction is that the latter creates a table in the worksheet that can be +used for different kind of formulas and can be sorted independently, though +is less flexible than basic cell regions.