forked from r-lib/usethis
/
rstudio.R
161 lines (138 loc) · 4.59 KB
/
rstudio.R
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
#' Add RStudio Project infrastructure
#'
#' It is likely that you want to use [create_project()] or [create_package()]
#' instead of `use_rstudio()`! Both `create_*()` functions can add RStudio
#' Project infrastructure to a pre-existing project or package. `use_rstudio()`
#' is mostly for internal use or for those creating a usethis-like package for
#' their organization. It does the following in the current project, often after
#' executing `proj_set(..., force = TRUE)`:
#' * Creates an `.Rproj` file
#' * Adds RStudio files to `.gitignore`
#' * Adds RStudio files to `.Rbuildignore`, if project is a package
#'
#' @export
use_rstudio <- function() {
rproj_file <- path_ext_set(project_name(), "Rproj")
new <- use_template("template.Rproj", rproj_file)
use_git_ignore(".Rproj.user")
if (is_package()) {
use_build_ignore(c(rproj_file, ".Rproj.user"))
}
invisible(new)
}
#' Don't save/load user workspace between sessions
#'
#' R can save and reload the user's workspace between sessions via an `.RData`
#' file in the current directory. However, long-term reproducibility is enhanced
#' when you turn this feature off and clear R's memory at every restart.
#' Starting with a blank slate provides timely feedback that encourages the
#' development of scripts that are complete and self-contained. More detail can
#' be found in the blog post [Project-oriented
#' workflow](https://www.tidyverse.org/articles/2017/12/workflow-vs-script/).
#'
#' Only `use_blank_slate("project")` is automated so far, since RStudio
#' currently only supports modification of user-level or global options via the
#' user interface.
#'
#' @inheritParams edit
#'
#' @export
use_blank_slate <- function(scope = c("user", "project")) {
scope <- match.arg(scope)
if (scope == "user") { # nocov start
todo(
"To start ALL RStudio sessions with a blank slate, ",
"you must set this interactively, for now."
)
todo(
"In {field('Global Options > General')}, ",
"do NOT check {field('Restore .RData into workspace at startup')}."
)
todo(
"In {field('Global Options > General')}, ",
"set {field('Save workspace to .RData on exit')} to {field('Never')}."
)
todo(
"Call {code('use_blank_slate(\"project\")')} to opt in to the ",
"blank slate workflow for a specific project."
)
return(invisible())
} # nocov end
if (!is_rstudio_project()) {
stop_glue("{value(project_name())} is not an RStudio Project.")
}
rproj_fields <- modify_rproj(
rproj_path(),
list(RestoreWorkspace = "No", SaveWorkspace = "No")
)
write_utf8(rproj_path(), serialize_rproj(rproj_fields))
restart_rstudio("Restart RStudio with a blank slate?")
invisible()
}
# Is base_path an RStudio Project or inside an RStudio Project?
is_rstudio_project <- function(base_path = proj_get()) {
res <- tryCatch(
rprojroot::find_rstudio_root_file(path = base_path),
error = function(e) NA
)
!is.na(res)
}
rproj_path <- function(base_path = proj_get()) {
rproj_path <- dir_ls(base_path, regexp = "[.]Rproj$")
if (length(rproj_path) > 1) {
stop_glue("Multiple .Rproj files found.")
}
if (length(rproj_path) == 1) rproj_path else NA_character_
}
# Is base_path open in RStudio?
in_rstudio <- function(base_path = proj_get()) {
if (!rstudioapi::isAvailable()) {
return(FALSE)
}
if (!rstudioapi::hasFun("getActiveProject")) {
return(FALSE)
}
proj <- rstudioapi::getActiveProject()
path_real(proj) == path_real(base_path)
}
in_rstudio_server <- function() {
if (!rstudioapi::isAvailable()) {
return(FALSE)
}
identical(rstudioapi::versionInfo()$mode, "server")
}
parse_rproj <- function(file) {
lines <- as.list(readLines(file, encoding = "UTF-8"))
has_colon <- grepl(":", lines)
fields <- lapply(lines[has_colon], function(x) strsplit(x, split = ": ")[[1]])
lines[has_colon] <- vapply(fields, `[[`, "character", 2)
names(lines)[has_colon] <- vapply(fields, `[[`, "character", 1)
names(lines)[!has_colon] <- ""
lines
}
modify_rproj <- function(file, update) {
utils::modifyList(parse_rproj(file), update)
}
serialize_rproj <- function(fields) {
named <- nzchar(names(fields))
as.character(ifelse(named, paste0(names(fields), ": ", fields), fields))
}
# Must be last command run
restart_rstudio <- function(message = NULL) {
if (!in_rstudio(proj_get())) {
return(FALSE)
}
if (!interactive()) {
return(FALSE)
}
if (!is.null(message)) {
todo(message)
}
if (!rstudioapi::hasFun("openProject")) {
return(FALSE)
}
if (nope(todo_bullet(), " Restart now?")) {
return(FALSE)
}
rstudioapi::openProject(proj_get())
}