diff --git a/README.md b/README.md index 60edfa7f..93899b52 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,24 @@ [![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/openxlsx)](https://cran.r-project.org/package=openxlsx) [![R-CMD-check](https://github.com/ycphs/openxlsx/actions/workflows/R-CMD-check.yaml/badge.svg?branch=master)](https://github.com/ycphs/openxlsx/actions/workflows/R-CMD-check.yaml) +This [R](https://www.R-project.org/) package simplifies the creation of `.xlsx` +files by providing a high level interface to writing, styling and editing +worksheets. Through the use of [`Rcpp`](https://CRAN.R-project.org/package=Rcpp), +read/write times are comparable to the [`xlsx`](https://CRAN.R-project.org/package=xlsx) +and [`XLConnect`](https://CRAN.R-project.org/package=XLConnect) packages with +the added benefit of removing the dependency on Java. + +**Note:** `openxlsx` is no longer under active development. The package is +maintained, and CRAN warnings will be fixed, but non-critical issues will not be +addressed unless accompanied by a pull request. Packages that depend on +`openxlsx` do not need to take any action, but for new developments, users are +encouraged to use alternatives like `readxl`, `writexl`, or `openxlsx2`. The +first two packages provide support for reading and writing `.xlsx` files. The +latter package is a modern reinterpretation of `openxlsx` and provides similar +functions to modify worksheets. However, it is not a drop-in replacement, so you +may want to consult resources like the +[update vignette](https://janmarvin.github.io/openxlsx2/articles/Update-from-openxlsx.html). - - -This [R](https://www.R-project.org/) package simplifies the creation of `.xlsx` files by providing -a high level interface to writing, styling and editing worksheets. Through the use of [`Rcpp`](https://CRAN.R-project.org/package=Rcpp), read/write times are comparable to the [`xlsx`](https://CRAN.R-project.org/package=xlsx) and -[`XLConnect`](https://CRAN.R-project.org/package=XLConnect) packages with the added benefit of removing the dependency on -Java. ## Installation @@ -31,12 +42,29 @@ install.packages(c("Rcpp", "remotes"), dependencies = TRUE) remotes::install_github("ycphs/openxlsx") ``` +## Example + +Explore the package with a simple example: + +```R +library(openxlsx) + +# Create a new workbook and add a sheet +wb <- createWorkbook() +addWorksheet(wb, "Sheet 1") + +# Write data to the sheet +writeData(wb, "Sheet 1", mtcars) + +# Save the workbook +saveWorkbook(wb, "my_mtcars.xlsx", overwrite = TRUE) +``` + ## Bug/feature request -Please let me know which version of openxlsx you are using when posting bug reports. +Please let us know which version of `openxlsx` you are using when posting bug reports. ```R packageVersion("openxlsx") ``` ## News -[Here](https://raw.githubusercontent.com/ycphs/openxlsx/master/NEWS.md). - +You can find the NEWS file [here](https://raw.githubusercontent.com/ycphs/openxlsx/master/NEWS.md).