Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/insightsengineering/rlistings

Value formatting and ASCII rendering infrastructure for tables and listings.
https://github.com/insightsengineering/rlistings

Last synced: about 1 month ago
JSON representation

Value formatting and ASCII rendering infrastructure for tables and listings.

Awesome Lists containing this project

README 

        
---

output: github_document

editor_options: 

  chunk_output_type: console

  markdown: 

    wrap: 72

---



```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-"

)

```



# rlistings 



[![Check 🛠](https://github.com/insightsengineering/rlistings/actions/workflows/check.yaml/badge.svg)](https://insightsengineering.github.io/rlistings/main/unit-test-report/)

[![Docs 📚](https://github.com/insightsengineering/rlistings/actions/workflows/docs.yaml/badge.svg)](https://insightsengineering.github.io/rlistings/)

[![Code Coverage 📔](https://raw.githubusercontent.com/insightsengineering/rlistings/_xml_coverage_reports/data/main/badge.svg)](https://insightsengineering.github.io/rlistings/main/coverage-report/)



![GitHub forks](https://img.shields.io/github/forks/insightsengineering/rlistings?style=social)

![GitHub Repo stars](https://img.shields.io/github/stars/insightsengineering/rlistings?style=social)



![GitHub commit activity](https://img.shields.io/github/commit-activity/m/insightsengineering/rlistings)

![GitHub contributors](https://img.shields.io/github/contributors/insightsengineering/rlistings)

![GitHub last commit](https://img.shields.io/github/last-commit/insightsengineering/rlistings)

![GitHub pull requests](https://img.shields.io/github/issues-pr/insightsengineering/rlistings)

![GitHub repo size](https://img.shields.io/github/repo-size/insightsengineering/rlistings)

![GitHub language count](https://img.shields.io/github/languages/count/insightsengineering/rlistings)

[![WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

[![Current Version](https://img.shields.io/github/r-package/v/insightsengineering/rlistings/main?color=purple\&label=package%20version)](https://github.com/insightsengineering/rlistings/tree/main)

[![Open Issues](https://img.shields.io/github/issues-raw/insightsengineering/rlistings?color=red\&label=open%20issues)](https://github.com/insightsengineering/rlistings/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)



## Listings with R



The `rlistings` R package is a package that was designed to create and

display listings with R. The focus of this package is to provide

functionality for value formatting and ASCII rendering infrastructure

for tables and listings. Many of the functions contained in `rlistings`

depend on the

[`formatters`](https://insightsengineering.github.io/formatters/)

package, which provides a framework for ASCII rendering and is available

on CRAN.



`rlistings` development is driven by the need to create regulatory ready

listings for health authority review. Some of the key requirements for

this undertaking are listed below:



-   flexible formatting (pagesize, column widths, alignment, labels,

    etc.)

-   multiple output formats (csv, out, txt)

-   repeated key columns

-   flexible pagination in both horizontal and vertical directions

-   titles and footnotes



`rlistings` currently covers some of these requirements, and remains

under active development.



## Installation



`rlistings` is available on CRAN and you can install the latest released

version with:



``` r

install.packages("rlistings")

```



or you can install the latest development version directly from GitHub

with:



``` r

remotes::install_github("insightsengineering/formatters")

remotes::install_github("insightsengineering/rlistings")

```



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/rlistings/releases).



## Cheatsheet






## Usage



The following example shows a simple listing and its printed output.



```{r}

library(rlistings)



# Reducing the data

mtcars_ex <- mtcars %>% dplyr::mutate("car" = rownames(mtcars))



as_listing(mtcars_ex,

  key_cols = c("gear", "carb"),

  disp_cols = c("gear", "carb", "qsec", "car")

) %>% head()

```



## Acknowledgment



This package is a result of a joint effort by many developers and

stakeholders. We would like to thank everyone who contributed so far!



## Stargazers and Forkers



### Stargazers over time



[![Stargazers over

time](https://starchart.cc/insightsengineering/rlistings.svg)](https://starchart.cc/insightsengineering/rlistings)



### Stargazers



[![Stargazers repo roster for

@insightsengineering/rlistings](https://reporoster.com/stars/insightsengineering/rlistings)](https://github.com/insightsengineering/rlistings/stargazers)



[![Forkers repo roster for

@insightsengineering/rlistings](https://reporoster.com/forks/insightsengineering/rlistings)](https://github.com/insightsengineering/rlistings/network/members)