-
Notifications
You must be signed in to change notification settings - Fork 0
/
use_badges.R
230 lines (195 loc) · 6.58 KB
/
use_badges.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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# use_badge_appveyor -----------------------------------------------------------
#' Badge appveyor
#' @param repo name of repository (default: NULL)
#' @param user user name or organisation under which repository defined in
#' parameter "repo" is hosted (default: KWB-R")
#' @param domain under which repository is hosted (default: "github")
#'
#' @return generates appveyor badge link
#' @export
use_badge_appveyor <- function(repo = NULL, user = "KWB-R", domain = "github")
{
pkgname <- get_pkgname(repo)
kwb.utils::resolve(
"url",
grammars$general,
grammars$appveyor,
domain = domain,
user = user,
pkgname = pkgname,
pkgname_dash = gsub("\\.", "-", pkgname)
)
}
# use_badge_travis -------------------------------------------------------------
#' Badge travis
#' @param repo name of repository (default: NULL)
#' @param user user name or organisation under which repository defined in
#' parameter "repo" is hosted (default: KWB-R")
#' @return generates travis badge link
#' @export
use_badge_travis <- function(repo = NULL, user = "KWB-R")
{
kwb.utils::resolve(
"url",
grammars$general,
grammars$travis,
user = user,
pkgname = get_pkgname(repo)
)
}
# use_badge_ghactions_rcmdcheck ------------------------------------------------
#' Badge Github Actions RCMD Check
#' @param repo name of repository (default: NULL)
#' @param user user name or organisation under which repository defined in
#' parameter "repo" is hosted (default: KWB-R")
#' @param branch default: NULL (i.e. use "default" branch) or user defined branch
#' (e.g. "dev")
#' @return generates travis badge link
#' @export
use_badge_ghactions_rcmdcheck <- function(repo = NULL, user = "KWB-R",
branch = NULL)
{
kwb.utils::resolve(
"url",
grammars$general,
grammars$ghactions_rcmdcheck,
user = user,
pkgname = get_pkgname(repo),
params = ifelse(is.null(branch), "", sprintf("?branch=%s", branch))
)
}
#' Badge Github Actions Pkgdown
#' @param repo name of repository (default: NULL)
#' @param user user name or organisation under which repository defined in
#' parameter "repo" is hosted (default: KWB-R")
#' @param branch default: NULL (i.e. use "default" branch) or user defined branch
#' (e.g. "dev")
#' @return generates Github Actions Pkgdown badge link
#' @export
use_badge_ghactions_pkgdown <- function(repo = NULL, user = "KWB-R", branch = NULL)
{
kwb.utils::resolve(
"url",
grammars$general,
grammars$ghactions_pkgdown,
user = user,
pkgname = get_pkgname(repo),
params = ifelse(is.null(branch), "", sprintf("?branch=%s", branch))
)
}
# use_badge_ghactions ----------------------------------------------------------
#' Badge Github Actions
#' @param repo name of repository (default: NULL)
#' @param user user name or organisation under which repository defined in
#' parameter "repo" is hosted (default: KWB-R")
#' @param branch default: NULL (i.e. use "default" branch) or user defined branch
#' (e.g. "dev")
#' @return generates Github Actions badges link
#' @export
use_badge_ghactions <- function(repo = NULL, user = "KWB-R", branch = NULL)
{
sprintf("%s\n%s",
use_badge_ghactions_rcmdcheck(repo, user, branch),
use_badge_ghactions_pkgdown(repo, user, branch)
)
}
# use_badge_codecov ------------------------------------------------------------
#' Badge codecov
#' @param repo name of repository (default: NULL)
#' @param user user name or organisation under which repository defined in
#' parameter "repo" is hosted (default: KWB-R")
#' @param domain under which repository is hosted (default: "github")
#' @return generates codecov badge link
#' @export
use_badge_codecov <- function(repo = NULL, user = "KWB-R", domain = "github")
{
kwb.utils::resolve(
"url",
grammars$general,
grammars$codecov,
domain = domain,
user = user,
pkgname = get_pkgname(repo)
)
}
# use_badge_lifecycle ----------------------------------------------------------
#' Badge lifecycle
#' @param stage badge declares the developmental stage of a package, according
#' to
#' [https://www.tidyverse.org/lifecycle/](https://www.tidyverse.org/lifecycle/),
#' valid arguments are: "experimental", "maturing", "stable", "retired",
#' "archived", "dormant", "questioning"), (default: "experiment")
#' @return generates lifecycle badge link
#' @export
use_badge_lifecycle <- function(stage = "experimental")
{
stages <- usethis:::stages
stage <- match.arg(tolower(stage), names(stages))
kwb.utils::resolve(
"url",
grammars$general,
grammars$lifecycle,
stage = stage,
colour = stages[[stage]]
)
}
# use_badge_cran ---------------------------------------------------------------
#' Badge CRAN
#' @param pkgname name of R package (default: NULL)
#' @importFrom httr GET status_code
#' @return generates CRAN badge link
#' @importFrom kwb.utils defaultIfNULL
#' @export
use_badge_cran <- function(pkgname = NULL)
{
pkgname <- kwb.utils::defaultIfNULL(pkgname, get_pkgname(pkgname))
cran_mirrors_link <- sapply(c("r-project", "rstudio"), function(org) {
kwb.utils::resolve("url", grammars$mirror, org = org, pkgname = pkgname)
})
# Indices of cran links that exist
indices <- which(is_on_cran(cran_mirrors_link))
href <- if (length(indices)) {
cran_mirrors_link[indices[1]]
} else {
""
}
kwb.utils::resolve(
"url", grammars$general, grammars$cran, pkgname = pkgname, href = href
)
}
# is_on_cran -------------------------------------------------------------------
#' Helper function for checking if docu on CRAN
#' @keywords internal
#' @noRd
is_on_cran <- function(cran_link)
{
stopifnot(is.character(cran_link))
# Call this function for all elements if there is more than one element
if (length(cran_link) > 1) {
return(sapply(cran_link, is_on_cran))
}
cran_link <- cran_link[1]
x <- try(httr::GET(cran_link), silent = TRUE)
errored <- inherits(x, "try-error")
if (errored) message(sprintf(
"Requesting %s failed with:\n%s", cran_link, attr(x, "condition")$message
))
! errored && httr::status_code(x) == 200
}
# use_badge_runiverse ----------------------------------------------------------
#' Badge R-Universe
#' @param repo name of repository (default: NULL)
#' @param user user name or organisation under which repository defined in
#' parameter "repo" is hosted (default: KWB-R")
#' @return generates codecov badge link
#' @export
use_badge_runiverse <- function(repo = NULL, user = "KWB-R")
{
kwb.utils::resolve(
"url",
grammars$general,
grammars$runiverse,
user = tolower(user),
pkgname = get_pkgname(repo)
)
}