## ----include = FALSE----------------------------------------------------------
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
options(rmarkdown.html_vignette.check_title = FALSE)

## ----setup--------------------------------------------------------------------
library(tablexlsx)
library(magrittr)

## ----define-export-folder-----------------------------------------------------
mypath <- tempdir()

## ----equivalent-syntaxes, eval = FALSE----------------------------------------
#  toxlsx(object = iris, path = mypath)
#  iris |> toxlsx(path = mypath)
#  iris %>% toxlsx(path = mypath)

## ----first-export, eval = FALSE-----------------------------------------------
#  iris |> toxlsx(path = mypath)

## ----list-export, eval = FALSE------------------------------------------------
#  list(iris,cars) |> toxlsx(path = mypath)

## ----df-export-merge-one, eval = FALSE----------------------------------------
#  # Create df1
#  df1 <- data.frame(
#    group = c("dupont","dupont","arnold","arnold"),
#    name = c("toto","tata","tutu","tete"),
#    volume = c(10,8,12,15)
#  )
#  #  Export
#  df1 |> toxlsx(path = mypath, mergecol = "group")

## ----df-export-merge-multiple, eval = FALSE-----------------------------------
#  sorted_mtcars <- mtcars[
#    order(mtcars$gear, mtcars$am),
#    c("gear", "am", setdiff(names(mtcars), c("gear", "am")))
#    ]
#  
#  sorted_mtcars |>
#    toxlsx(path = mypath, mergecol = c("gear", "am"))

## ----df-export-split, eval = FALSE--------------------------------------------
#  df1 |> toxlsx(path = mypath, bygroup= "group", groupname=TRUE)

## ----list-export-same, eval = FALSE-------------------------------------------
#  tb1 <- data.frame(tables = c(rep("iris",5),rep("cars",2)),
#                    var = c(names(iris),names(cars)))
#  
#  tb2 <- data.frame(tables = c("iris","cars","cars"),
#                    rownumber = c(150,50,32))
#  
#  list(tb1,tb2) |>
#    toxlsx(tosheet = "mydata",
#           mergecol = "tables",
#           footnote1 = list("tb1" = "The data set contains 3 classes of 50 instances each, where each class refers to a type of iris plant.",
#                            "tb2" = "The data give the speed of cars and the distances taken to stop. Note that the data were recorded in the 1920s."),
#           footnote2 = list("tb1" = "Predicted attribute: class of iris plant.",
#                            "tb2" = "Data recorded in the 1920s"),
#           footnote3 = list("tb1" = "Source : R.A. Fisher",
#                            "tb2" = "Source : M. Ezekiel"),
#           path=mypath)

## ----list-export-complicated, eval = FALSE------------------------------------
#  iris <- iris %>% head()
#  cars <- cars %>% head()
#  
#  list(iris,cars) |>
#    toxlsx(tosheet = list("iris" = "first",
#                          "cars" = "second"),
#           title = list("iris" = "Head of iris",
#                        "cars" = "Head of cars"),
#           mergecol = list("iris" = "Species",
#                           "cars" = "speed"),
#           # The `columnstyle` argument is optional in toxlsx().
#           # It is used only if you want to specify the format of each column
#           columnstyle = list("iris" = list("c1" = "decimal",
#                                            "c2" = "decimal",
#                                            "c3" = "number",
#                                            "c4" = "number",
#                                            "c5" = "character"),
#                              "cars" =  list("c1" = "number",
#                                             "c2" = "number")),
#           footnote1 = list("iris" = "The data set contains 3 classes of 50 instances each, where each class refers to a type of iris plant.",
#                             "cars" = "The data give the speed of cars and the distances taken to stop. Note that the data were recorded in the 1920s."),
#           footnote2 = list("iris" = "Predicted attribute: class of iris plant.",
#                             "cars" = "Data recorded in the 1920s"),
#           footnote3 = list("iris" = "Source : R.A. Fisher",
#                             "cars" = "Source : M. Ezekiel"),
#           filename = "Results",
#           path = mypath)