-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
117 lines (86 loc) · 4.54 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
---
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%"
)
```
# rsTeachMode
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#experimental) [](https://CRAN.R-project.org/package=rsTeachMode) <!--[](https://codecov.io/gh/murraycadzow/rsTeachMode?branch=main) --> [](https://github.com/murraycadzow/rsTeachMode/actions)
<!-- badges: end -->
The goal of rsTeachMode is to provide an easy mechanism to switch between theme preferences for personal use and theme preferences for a teaching environment in RStudio.
**Requires version \>1.3.387 of RStudio**
## No installation option:
Insert the following into your `.Rprofile` which can be opened (if you have `{usethis}` installed) by using `usethis::edit_r_profile()`
```{r}
# Toggle between user rstudio preferences and teaching preferences
# Changes theme and font sizes
# Requires {rstudioapi} to be installed
.toggle <- function(){
# Assumes you are in user mode if first time running in session
rsTeachMode_options <- getOption("rsTeachMode")
if(is.null(rsTeachMode_options)){
# CHANGE SETTINGS HERE ####
rsTeachMode_options <- list(
mode = "user", # start in user mode. Options are "user" or "teach"
user_theme_name = "Solarized Dark", # change to theme name of choice for user
user_font_size = 12, # change to desired font size
teach_theme_name = "Chrome", # change to theme name of choice for teaching
teach_font_size = 24 # change to desired font size
)
###########################
}
# use the data type currently being used by the system
if (class(rstudioapi::readPreference("font_size_points", FALSE)) == "integer") {
rsTeachMode_options$user_font_size <- as.integer(rsTeachMode_options$user_font_size)
rsTeachMode_options$teach_font_size <- as.integer(rsTeachMode_options$teach_font_size)
}
# teach -> user
if (rsTeachMode_options$mode == "teach") {
rstudioapi::writeRStudioPreference("font_size_points", rsTeachMode_options$user_font_size)
rstudioapi::applyTheme(rsTeachMode_options$user_theme_name)
} else {# user -> teach
rstudioapi::writeRStudioPreference("font_size_points", rsTeachMode_options$teach_font_size)
rstudioapi::applyTheme(rsTeachMode_options$teach_theme_name)
}
# flip the mode in the stored options
rsTeachMode_options$mode <- ifelse(rsTeachMode_options$mode == "teach", "user", "teach")
options(rsTeachMode = rsTeachMode_options)
}
```
Then you can run `.toggle()` when you want to switch between user and teaching mode.
## Installation
This package is under development and very experimental but can be installed from github using:
``` r
remotes::install_github("murraycadzow/rsTeachMode@main")
```
## Inital setup
This will use your current theme and editor font settings as the 'user' options and set your teaching settings to the "Chrome" theme with a font size of 24. The use of `quite = FALSE` prints out the code to add to your .Rprofile that is needed to maintain these settings between sessions.
```{r example, eval = FALSE}
library(rsTeachMode)
# keeps your current settings as your 'user' settings and sets preferences for 'teaching' use
set_teach_mode_settings(teach_theme_name = "Chrome",
teach_font_size = 24,
quiet = FALSE)
# Specify all settings
set_teach_mode_settings(current_mode = "user",
user_theme_name = "Solarized Light",
user_font_size = 12,
teach_theme_name = "Chrome",
teach_font_size = 24,
quiet = FALSE)
```
Once you have created your set your settings toggle between the two modes with:
```{r, eval = FALSE}
toggle_teach_mode()
```
Or set it to a keyboard shortcut using the addin.
## RStudio Addins
There are addins as part of this package that make it easy to create keyboard shortcuts for the common features.
To set a keyboard shortcut, in the Rstudio menu go `Tools -> Modify Keyboard Shortcuts` and then filter for "Toggle Teach Mode" or one of the names of the other addins.