devtools::build_readme()

README.Rmd

@@ -1,7 +1,6 @@
-
 ---
 output: github_document
-editor_options: 
+editor_options:
   chunk_output_type: console
 ---
 

README.md

@@ -1,88 +1,108 @@
 
----
-output: github_document
-editor_options: 
-  chunk_output_type: console
----
-
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-
-
 # rtables <a href='https://github.com/insightsengineering/rtables'><img src="man/figures/logo.png" align="right" height="200" width="200"/></a>
 
 <!-- start badges -->
-[![Check 🛠](https://github.com/insightsengineering/rtables/actions/workflows/check.yaml/badge.svg)](https://github.com/insightsengineering/rtables/actions/workflows/check.yaml)
-[![Docs 📚](https://github.com/insightsengineering/rtables/actions/workflows/docs.yaml/badge.svg)](https://insightsengineering.github.io/rtables/)
-[![Code Coverage 📔](https://raw.githubusercontent.com/insightsengineering/rtables/_xml_coverage_reports/data/main/badge.svg)](https://raw.githubusercontent.com/insightsengineering/rtables/_xml_coverage_reports/data/main/coverage.xml)
-
-![GitHub forks](https://img.shields.io/github/forks/insightsengineering/rtables?style=social)
-![GitHub repo stars](https://img.shields.io/github/stars/insightsengineering/rtables?style=social)
-
-![GitHub commit activity](https://img.shields.io/github/commit-activity/m/insightsengineering/rtables)
-![GitHub contributors](https://img.shields.io/github/contributors/insightsengineering/rtables)
-![GitHub last commit](https://img.shields.io/github/last-commit/insightsengineering/rtables)
-![GitHub pull requests](https://img.shields.io/github/issues-pr/insightsengineering/rtables)
-![GitHub repo size](https://img.shields.io/github/repo-size/insightsengineering/rtables)
-![GitHub language count](https://img.shields.io/github/languages/count/insightsengineering/rtables)
-[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
-[![Open Issues](https://img.shields.io/github/issues-raw/insightsengineering/rtables?color=red\&label=open%20issues)](https://github.com/insightsengineering/rtables/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
-
-[![CRAN Version](https://www.r-pkg.org/badges/version/rtables)](https://CRAN.R-project.org/package=rtables)
-[![Current Version](https://img.shields.io/github/r-package/v/insightsengineering/rtables/main?color=purple\&label=Development%20Version)](https://github.com/insightsengineering/rtables/tree/main)
+
+[![Check
+🛠](https://github.com/insightsengineering/rtables/actions/workflows/check.yaml/badge.svg)](https://github.com/insightsengineering/rtables/actions/workflows/check.yaml)
+[![Docs
+📚](https://github.com/insightsengineering/rtables/actions/workflows/docs.yaml/badge.svg)](https://insightsengineering.github.io/rtables/)
+[![Code Coverage
+📔](https://raw.githubusercontent.com/insightsengineering/rtables/_xml_coverage_reports/data/main/badge.svg)](https://raw.githubusercontent.com/insightsengineering/rtables/_xml_coverage_reports/data/main/coverage.xml)
+
+![GitHub
+forks](https://img.shields.io/github/forks/insightsengineering/rtables?style=social)
+![GitHub repo
+stars](https://img.shields.io/github/stars/insightsengineering/rtables?style=social)
+
+![GitHub commit
+activity](https://img.shields.io/github/commit-activity/m/insightsengineering/rtables)
+![GitHub
+contributors](https://img.shields.io/github/contributors/insightsengineering/rtables)
+![GitHub last
+commit](https://img.shields.io/github/last-commit/insightsengineering/rtables)
+![GitHub pull
+requests](https://img.shields.io/github/issues-pr/insightsengineering/rtables)
+![GitHub repo
+size](https://img.shields.io/github/repo-size/insightsengineering/rtables)
+![GitHub language
+count](https://img.shields.io/github/languages/count/insightsengineering/rtables)
+[![Project Status: Active – The project has reached a stable, usable
+state and is being actively
+developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![Open
+Issues](https://img.shields.io/github/issues-raw/insightsengineering/rtables?color=red&label=open%20issues)](https://github.com/insightsengineering/rtables/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
+
+[![CRAN
+Version](https://www.r-pkg.org/badges/version/rtables)](https://CRAN.R-project.org/package=rtables)
+[![Current
+Version](https://img.shields.io/github/r-package/v/insightsengineering/rtables/main?color=purple&label=Development%20Version)](https://github.com/insightsengineering/rtables/tree/main)
 <!-- end badges -->
 
 ## Reporting tables with R
 
-The `rtables` R package was designed to create and display complex tables with R. The cells in an `rtable` may contain
-any high-dimensional data structure which can then be displayed with cell-specific formatting instructions. Currently,
-`rtables` can be outputted in `ascii` `html`, and `pdf`, as well Power Point (via conversion to `flextable` objects). `rtf` support is in development and will be in a future release.
-
-`rtables` is developed and copy written by `F. Hoffmann-La Roche` and it is released open source under Apache
-License Version 2.
-
-`rtables` development is driven by the need to create regulatory ready tables for health authority review. Some of the key requirements for this undertaking are listed below:
-
-* cell values and their visualization separate (i.e. no string based tables)
-  - values need to be programmatically accessible in their non-rounded state for cross-checking
-* multiple values displayed within a cell
-* flexible tabulation framework
-* flexible formatting (cell spans, rounding, alignment, etc.)
-* multiple output formats (html, ascii, latex, pdf, xml)
-* flexible pagination in both horizontal and vertical directions
-* distinguish between name and label in the data structure to work with `CDISC` standards
-* title, footnotes, cell cell/row/column references
-
-`rtables` currently covers virtually all of these requirements, and further advances remain under active development.
-
+The `rtables` R package was designed to create and display complex
+tables with R. The cells in an `rtable` may contain any high-dimensional
+data structure which can then be displayed with cell-specific formatting
+instructions. Currently, `rtables` can be outputted in `ascii` `html`,
+and `pdf`, as well Power Point (via conversion to `flextable` objects).
+`rtf` support is in development and will be in a future release.
+
+`rtables` is developed and copy written by `F. Hoffmann-La Roche` and it
+is released open source under Apache License Version 2.
+
+`rtables` development is driven by the need to create regulatory ready
+tables for health authority review. Some of the key requirements for
+this undertaking are listed below:
+
+- cell values and their visualization separate (i.e. no string based
+  tables)
+  - values need to be programmatically accessible in their non-rounded
+    state for cross-checking
+- multiple values displayed within a cell
+- flexible tabulation framework
+- flexible formatting (cell spans, rounding, alignment, etc.)
+- multiple output formats (html, ascii, latex, pdf, xml)
+- flexible pagination in both horizontal and vertical directions
+- distinguish between name and label in the data structure to work with
+  `CDISC` standards
+- title, footnotes, cell cell/row/column references
+
+`rtables` currently covers virtually all of these requirements, and
+further advances remain under active development.
 
 ## Installation
 
-`rtables` is available on CRAN and you can install the latest released version with:
+`rtables` is available on CRAN and you can install the latest released
+version with:
 
-```r
+``` r
 install.packages("rtables")
 ```
 
-or you can install the latest development version directly from GitHub with:
+or you can install the latest development version directly from GitHub
+with:
 
-```r
+``` r
 remotes::install_github("insightsengineering/formatters")
 remotes::install_github("insightsengineering/rtables")
 ```
 
-Note you might need to set your `GITHUB_PAT` environment variable in order to be able to install from GitHub.
+Note you might need to set your `GITHUB_PAT` environment variable in
+order to be able to install from GitHub.
 
-Packaged releases (both those on CRAN and those between official CRAN releases) can be
-found in the [releases list](https://github.com/insightsengineering/rtables/releases).
+Packaged releases (both those on CRAN and those between official CRAN
+releases) can be found in the [releases
+list](https://github.com/insightsengineering/rtables/releases).
 
 ## Usage
 
-We first demonstrate with a demographic table-like example and then show the creation of a more complex table.
-
-
+We first demonstrate with a demographic table-like example and then show
+the creation of a more complex table.
 
-```r
+``` r
 library(rtables)
 
 lyt <- basic_table() %>%
@@ -119,9 +139,7 @@ build_table(lyt, ex_adsl)
 #>   HIGH             47              33               50
 ```
 
-
-
-```r
+``` r
 library(rtables)
 library(dplyr)
 
@@ -172,12 +190,14 @@ basic_table(show_colcounts = TRUE) %>%
 #>     Biomarker 1 (mean)         3.94       no data     no data        3.77       no data      no data     no data      no data      no data
 ```
 
-
 # Acknowledgments
 
-We would like to thank everyone who has made `rtables` a better project by providing feedback and improving examples & vignettes. The following list of contributors is alphabetical:
+We would like to thank everyone who has made `rtables` a better project
+by providing feedback and improving examples & vignettes. The following
+list of contributors is alphabetical:
 
-Maximo Carreras, Francois Collins, Saibah Chohan, Tadeusz Lewandowski, Nick Paszty, Nina Qi, Jana Stoilova, Heng Wang, Godwin Yung
+Maximo Carreras, Francois Collins, Saibah Chohan, Tadeusz Lewandowski,
+Nick Paszty, Nina Qi, Jana Stoilova, Heng Wang, Godwin Yung
 
 ## Presentations