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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
#' Create a modeling package
#'
#' @description
#'
#' `create_modeling_package()` will:
#' - Call `usethis::create_package()` to set up a new R package.
#' - Call `use_modeling_deps()`.
#' - Call `use_modeling_files()`.
#'
#' `use_modeling_deps()` will:
#' - Add hardhat, rlang, and stats to Imports
#' - Add recipes to Suggests
#' - If roxygen2 is available, use roxygen markdown
#'
#' `use_modeling_files()` will:
#' - Add a package documentation file
#' - Generate and populate 3 files in `R/`:
#' - `{{model}}-constructor.R`
#' - `{{model}}-fit.R`
#' - `{{model}}-predict.R`
#'
#' @param model A string. The name of the high level modeling function that
#' users will call. For example, `"linear_regression"`. This will be used to
#' populate the skeleton. Spaces are not allowed.
#'
#' @param path A path. If it exists, it is used. If it does not exist,
#' it is created, provided that the parent path exists.
#'
#' @param fields A named list of fields to add to DESCRIPTION,
#' potentially overriding default values. See `usethis::use_description()` for
#' how you can set personalized defaults using package options.
#'
#' @param open If TRUE, activates the new project:
#' - If RStudio desktop, the package is opened in a new session.
#' - If on RStudio server, the current RStudio project is activated.
#' - Otherwise, the working directory and active project is changed.
#'
#' @return
#'
#' `create_modeling_package()` returns the project path invisibly.
#'
#' `use_modeling_deps()` returns invisibly.
#'
#' `use_modeling_files()` return `model` invisibly.
#'
#' @name modeling-package
#' @export
create_modeling_package <- function(path,
model,
fields = NULL,
open = interactive()) {
check_required(path)
check_required(model)
validate_installed("usethis")
validate_installed("roxygen2")
validate_installed("devtools")
validate_installed("recipes")
# Avoid creating files if a bad model is supplied
if (!is_string(model)) {
abort("`model` must be a single string.")
}
if (has_spaces(model)) {
abort("`model` must not contain any spaces.")
}
usethis::create_package(path, fields, open = FALSE)
# copied from create_package()
old_project <- usethis::proj_set(path, force = TRUE)
on.exit(usethis::proj_set(old_project), add = TRUE)
ui_blank_line()
use_modeling_deps()
use_modeling_files_impl(model, prompt_document = FALSE)
# Use the same option as used by the usethis `ui_*()` family
quiet <- getOption("usethis.quiet", default = FALSE)
# Only auto-document when creating _new_ packages
# Must explicitly set the pkg path
usethis::ui_info("Running {usethis::ui_code('devtools::document()')}")
devtools::document(pkg = usethis::proj_get(), quiet = quiet)
ui_blank_line()
# copied from create_package()
if (open) {
if (usethis::proj_activate(path)) {
on.exit()
}
}
invisible(usethis::proj_get())
}
#' @rdname modeling-package
#' @export
use_modeling_deps <- function() {
validate_installed("usethis")
validate_installed("roxygen2")
validate_installed("devtools")
validate_installed("recipes")
usethis::ui_info("Adding required packages to the DESCRIPTION")
usethis::use_package("hardhat", type = "Imports")
usethis::use_package("rlang", type = "Imports")
usethis::use_package("stats", type = "Imports")
usethis::use_package("recipes", type = "Suggests")
ui_blank_line()
usethis::ui_info("Setting up roxygen")
usethis::use_roxygen_md()
ui_blank_line()
invisible()
}
#' @rdname modeling-package
#' @export
use_modeling_files <- function(model) {
use_modeling_files_impl(model)
}
use_modeling_files_impl <- function(model, prompt_document = TRUE) {
validate_installed("usethis")
if (!is_string(model)) {
abort("`model` must be a string.")
}
if (has_spaces(model)) {
abort("`model` must not contain any spaces.")
}
data <- list(model = model)
use_hardhat_template <- function(template, save_as) {
usethis::use_template(
template = template,
save_as = save_as,
data = data,
package = "hardhat"
)
}
path_constructor <- glue::glue("R/{model}-constructor.R")
path_fit <- glue::glue("R/{model}-fit.R")
path_predict <- glue::glue("R/{model}-predict.R")
usethis::ui_info("Writing skeleton files")
usethis::use_package_doc(open = FALSE)
use_hardhat_template("R/constructor.R", path_constructor)
use_hardhat_template("R/fit.R", path_fit)
use_hardhat_template("R/predict.R", path_predict)
if (prompt_document) {
usethis::ui_todo("Run {usethis::ui_code('devtools::document()')}")
} else {
ui_blank_line()
}
invisible(model)
}
# ------------------------------------------------------------------------------
has_spaces <- function(x) {
grepl("\\s", x)
}
validate_installed <- function(pkg) {
if (!requireNamespace(pkg, quietly = TRUE)) {
abort(paste0("The `", pkg, "` package must be installed for this functionality."))
}
}
ui_blank_line <- function() {
validate_installed("usethis")
usethis::ui_line("")
}
|
