-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathREADME.Rmd
144 lines (103 loc) · 7.11 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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE, comment = "#>", fig.path = "man/figures/README-", out.width = "100%", message = FALSE, warning = FALSE, error = FALSE
)
```
# lcars <img src="man/figures/logo.png" style="margin-left:10px;margin-bottom:5px;" width="120" align="right">
<!-- badges: start -->
[](https://www.repostatus.org/)
[](https://github.com/leonawicz/lcars/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/leonawicz/lcars)
[](https://CRAN.R-project.org/package=lcars)
[](https://cran.r-project.org/package=lcars)
[](https://github.com/leonawicz/lcars)
<!-- badges: end -->
## Library Computer Access/Retrieval System ([LCARS](https://en.wikipedia.org/wiki/LCARS))
The `lcars` package provides Shiny widgets and Shiny UI theme that support an LCARS aesthetic for Shiny apps.
Using an LCARS aesthetic to visually frame the results of your analysis is fun and quirky in its own right, but it begs the next obvious step: interactivity. LCARS-themed displays can be fun to make, but using Shiny is much more exciting because you can make something with the look and feel of LCARS that also is *actually operational* and not just another piece of static digital fan art!
That's right. Make your Shiny app, view it on a touch screen device like your very own Federation-issue data PADD, and transport yourself into the future of the Star Trek universe with this 1980s sci-fi television aesthetic!
### Function names
The package also offers `lcars_border()` and associated functions for adding a minimal LCARS theme to static ggplot2 graphs, but this is less interesting given the context and won't look as authentic and the Shiny counterparts.
On the topic of the split between Shiny and non-Shiny functions, most of the package is Shiny-related. There is less focus on the ggplot border effect and related border component functions. Shiny functions use camel case like `lcarsBox()` whereas non-Shiny functions use snake case like `lcars_border()`. Most users will probably only use the Shiny functions.
### Shiny functions
There are several Shiny functions available. These are UI containers and widgets that provide various LCARS aesthetics.
UI setup and containers:
* `lcarsPage()`
* `lcarsBox()`
* `lcarsSweep()`
* `lcarsBracket()`
* `lcarsWell()`
* `inputColumn()`
Headers and indicators:
* `lcarsHeader()`, `lcarsh1()` through `lcarsh6()`.
* `lcarsRect()`, `lcarsPill()`, etc.
Input controls
* `lcarsButton()`
* `lcarsCheckbox()`
* `lcarsToggle()`
* `lcarsRadio()`
* `lcarsRadioToggle()`
The key widgets are `lcarsHeader()`, `lcarsBox()` and `lcarsSweep()`. An example of the header and box is shown above. Here is a combined LCARS sweep and reverse sweep:
The screenshots above are taken directly from demo apps included in the package. See `lcarsApp()` for details. For detailed examples including Shiny app examples, see the package [vignette](https://leonawicz.github.io/lcars/articles/lcars.html).
## Installation
Install the CRAN release of `lcars` with
```r
install.packages("lcars")
```
Install the development version from GitHub with
```r
# install.packages("remotes")
remotes::install_github("leonawicz/lcars")
```
## Limitations
In adhering closely to sizing and layout rules for LCARS UI design, fixed sizing works best for some container widgets like `lcarBox()` and `lcarsSweep()`. You can use settings like `width = "100%"` for these containers, but you may notice limitations in maintaining a responsive UI, particularly when they contain plot outputs. Fixed width widgets are generally recommended.
Visual components such as the LCARS elbow shape underlying some widgets are intended to follow strict sizing and scaling rules. They are not intended to scale arbitrarily or fit well on very small device screens.
## Packages in the trekverse
<div class="row">
<div class="col-sm-2">
<a href="https://github.com/leonawicz/rtrek"><img src="https://raw.githubusercontent.com/leonawicz/rtrek/master/man/figures/logo.png" style="margin-right:20px;margin-bottom:0;" width="120" align="left"></a>
</div>
<div class="col-sm-10">
<h4 style="padding:30px 0 0 0;margin-top:5px;margin-bottom:5px;"><a href="https://github.com/leonawicz/rtrek">rtrek</a>: The core Star Trek package</h4>
Datasets related to Star Trek, API wrappers to external data sources, and more.
</div></div>
<br/>
<div class="row">
<div class="col-sm-2">
<a href="https://github.com/leonawicz/lcars"><img src="https://raw.githubusercontent.com/leonawicz/lcars/master/man/figures/logo.png" style="margin-right:20px;margin-bottom:0;" width="120" align="left"></a>
</div>
<div class="col-sm-10">
<h4 style="padding:30px 0 0 0;margin-top:5px;margin-bottom:5px;"><a href="https://github.com/leonawicz/lcars">lcars</a>: LCARS aesthetic for Shiny</h4>
Create Shiny apps based on the Library Computer Access/Retrieval System (LCARS).
</div></div>
<br/>
<div class="row">
<div class="col-sm-2">
<a href="https://github.com/leonawicz/trekcolors"><img src="https://raw.githubusercontent.com/leonawicz/trekcolors/master/man/figures/logo.png" style="margin-right:20px;margin-bottom:0;" width="120" align="left"></a>
</div>
<div class="col-sm-10">
<h4 style="padding:30px 0 0 0;margin-top:5px;margin-bottom:5px;"><a href="https://github.com/leonawicz/trekcolors">trekcolors</a>: A color palette package</h4>
Predefined and customizable Star Trek themed color palettes and related functions.
</div></div>
<br/>
<div class="row">
<div class="col-sm-2">
<a href="https://github.com/leonawicz/trekfont"><img src="https://raw.githubusercontent.com/leonawicz/trekfont/master/man/figures/logo.png" style="margin-right:20px;margin-bottom:0;" width="120" align="left"></a>
</div>
<div class="col-sm-10">
<h4 style="padding:30px 0 0 0;margin-top:5px;margin-bottom:5px;"><a href="https://github.com/leonawicz/trekfont">trekfont</a>: A fonts package</h4>
True (Trek) type fonts to style your Star Trek themed graphics text.
</div></div>
<br>
## Citation
Matthew Leonawicz (`r substr(Sys.Date(), 1, 4)`). lcars: LCARS Aesthetic for Shiny. R package version 0.4.0. https://CRAN.R-project.org/package=lcars
## Contribute
Contributions are welcome. Contribute through GitHub via pull request. Please create an issue first if it is regarding any substantive feature add or change.
---
Please note that the `lcars` project is released with a [Contributor Code of Conduct](https://github.com/leonawicz/lcars/blob/master/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.