-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
README.Rmd
127 lines (93 loc) · 5.34 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
---
output: github_document
editor_options:
chunk_output_type: console
markdown:
wrap: 72
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
# rlistings <a href='https://github.com/insightsengineering/rlistings'><img src="man/figures/logo.png" align="right" height="200" width="200"/></a>
<!-- start badges -->
[](https://insightsengineering.github.io/rlistings/main/unit-test-report/)
[](https://insightsengineering.github.io/rlistings/)
[](https://insightsengineering.github.io/rlistings/main/coverage-report/)
[](https://www.repostatus.org/#wip)
[](https://github.com/insightsengineering/rlistings/tree/main)
[](https://github.com/insightsengineering/rlistings/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
<!-- end badges -->
## 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
# install.packages("pak")
pak::pak("insightsengineering/rlistings")
```
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).
To understand how to use this package, please refer to the [Introduction to `rlistings`](https://insightsengineering.github.io/rlistings/latest-tag/articles/rlistings.html) article, which provides multiple examples of code implementation.
## Cheatsheet
<a href="https://github.com/insightsengineering/rlistings/blob/main/inst/cheatsheet/rlistings_cheatsheet_03-24.pdf"><img src="https://raw.githubusercontent.com/insightsengineering/rlistings/main/inst/cheatsheet/rlistings_cheatsheet_03-24_thumbs.png" width="630" height="249"/></a>
## 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
[](https://starchart.cc/insightsengineering/rlistings)
### Stargazers
[](https://github.com/insightsengineering/rlistings/stargazers)
[](https://github.com/insightsengineering/rlistings/network/members)