Skip to content

Commit d65e465

Browse files
Package moved to the 'futureverse' GitHub organization
1 parent e48add4 commit d65e465

File tree

7 files changed

+63
-42
lines changed

7 files changed

+63
-42
lines changed

.make/README.md.rsp

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
<%
66
format <- c("markdown", "html")[2]
77

8+
find_file <- function(filename) {
9+
path <- file.path("incl", filename)
10+
if (file.exists(path)) return(path)
11+
if (file.exists(filename)) return(filename)
12+
NA_character_
13+
}
14+
15+
816
pkg <- local({
917
name <- NULL
1018
function() {
@@ -113,10 +121,13 @@ repos_status <- function() {
113121
if (cran()) {
114122
a("https://CRAN.R-project.org/web/checks/check_results_%s.html", pkg(), body = img("https://www.r-pkg.org/badges/version/%s", pkg(), alt="CRAN check status"))
115123
} else if (bioc()) {
124+
biocSince <- function() {
125+
a("https://bioconductor.org/packages/%s/", pkg(), body = img("https://bioconductor.org/shields/years-in-bioc/%s.svg", pkg(), alt="Bioconductor since badge"))
126+
}
116127
biocURL <- function(type) {
117128
a("https://bioconductor.org/checkResults/%s/bioc-LATEST/%s/", type, pkg(), body = img("https://bioconductor.org/shields/build/%s/bioc/%s.svg", type, pkg(), alt="Bioconductor build status"))
118129
}
119-
paste(biocURL(c("release", "devel")), collapse="</br>")
130+
paste(c(biocSince(), biocURL(c("release", "devel"))), collapse=" ")
120131
} else {
121132
""
122133
}
@@ -139,10 +150,19 @@ github_revdepcheck_top <- function(name = "revdepcheck-top", text = FALSE) {
139150
a("https://github.com/%s/actions?query=workflow%%3A%s", repos, name, body=body)
140151
}
141152

153+
github_future.tests <- function(name = "future_tests", text = FALSE) {
154+
if (!file.exists(sprintf(".github/workflows/%s.yaml", name))) return("")
155+
repos <- github_repos()
156+
body <- img("https://github.com/%s/actions/workflows/%s.yaml/badge.svg?branch=develop", github_repos(), name, alt="future.tests checks status")
157+
if (text) body <- "GitHub Actions"
158+
a("https://github.com/%s/actions?query=workflow%%3A%s", repos, name, body=body)
159+
}
160+
142161
github <- function(text = FALSE) {
143162
paste(c(
144163
github_r_cmd_check(text = text),
145-
github_revdepcheck_top(text = text)
164+
github_revdepcheck_top(text = text),
165+
github_future.tests(text = text)
146166
), collapse = " ")
147167
}
148168

@@ -168,15 +188,9 @@ appveyor <- function(text = FALSE) {
168188

169189
covr <- function() {
170190
bfr <- NULL
171-
files <- c("covr.yaml", "R-CMD-check.yaml")
172-
for (file in file.path(".github/workflows", files)) {
173-
if (file.exists(file)) {
174-
bfr <- readLines(file)
175-
break
176-
}
177-
}
178-
if (!any(grepl("covr::codecov", bfr, fixed=TRUE))) return()
179-
a("https://codecov.io/gh/%s", github_repos(), body=img("https://codecov.io/gh/%s/branch/develop/graph/badge.svg", github_repos(), alt="Coverage Status"))
191+
files <- c("test-coverage.yaml", "covr.yaml")
192+
if (!any(file_test("-f", file.path(".github/workflows/", files)))) return()
193+
a("https://app.codecov.io/gh/%s", github_repos(), body=img("https://codecov.io/gh/%s/branch/develop/graph/badge.svg", github_repos(), alt="Coverage Status"))
180194
}
181195
%>
182196

@@ -193,12 +207,13 @@ optional_badges <- function() {
193207
<%=repos_status()%> <%=github()%> <%=travis()%> <%=appveyor() %> <%=covr()%> <%=optional_badges()%>
194208
</div>
195209

196-
# <%=pkg()%>: <%=pkg_title()%> <% if (file.exists(file <- "man/figures/logo.png")) { cat(img(file, alt="The 'future' hexlogo", align="right")) } %>
210+
# <%=pkg()%>: <%=pkg_title()%> <% if (file.exists(file <- "man/figures/logo.png")) { cat(img(file, alt=sprintf("The '%s' hexlogo", pkg()), align="right")) } %>
197211

198-
<% if (file.exists("OVERVIEW.md")) { R.rsp::rcat(file="OVERVIEW.md") } %>
212+
<% if (!is.na(file <- find_file("OVERVIEW.md"))) { R.rsp::rcat(file=file) } %>
199213

200-
<% if (file.exists("INSTALL.md")) {
201-
R.rsp::rcat(file="INSTALL.md")
214+
<%
215+
if (!is.na(file <- find_file("INSTALL.md"))) {
216+
R.rsp::rcat(file=file)
202217
} else { %>
203218
## Installation
204219
<% if (cran()) { %>
@@ -233,16 +248,16 @@ remotes::install_github("<%=github_repos()%>", ref="develop")
233248
This will install the package from source. <% if (file.exists("src")) { %><%-%>
234249
Because of this and because this package also compiles native code, Windows users need to have [Rtools](https://cran.r-project.org/bin/windows/Rtools/) installed and macOS users need to have [Xcode](https://developer.apple.com/xcode/) installed.
235250
<% } # if (file.exists("src")) %>
236-
<% } # if (file.exists("INSTALL.md")) %>
251+
<% } # if (... "INSTALL.md" ...) %>
237252

238253

239254
<!-- pkgdown-drop-below -->
240255

241-
<% if (file.exists("CONTRIBUTING.md") &&
256+
<% if (!is.na(file <- find_file("CONTRIBUTING.md")) &&
242257
any(grepl("README.*md", readLines(".Rbuildignore")))) { %>
243258

244259
## Contributing
245260

246-
To contribute to this package, please see [CONTRIBUTING.md](CONTRIBUTING.md).
261+
To contribute to this package, please see [CONTRIBUTING.md](<%= file %>).
247262

248263
<% } # if (...) %>

DESCRIPTION

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: future.tests
22
Title: Test Suite for 'Future API' Backends
3-
Version: 0.7.0-9000
3+
Version: 0.7.0-9001
44
Authors@R: c(
55
person("Henrik", "Bengtsson", role = c("aut", "cre", "cph"), email = "henrikb@braju.com"),
66
person(family = "The R Consortium", comment = "Project was awared an Infrastructure Steering Committee (ISC) grant in 2017", role = "fnd"))
@@ -21,7 +21,7 @@ Suggests:
2121
VignetteBuilder: future.tests
2222
License: LGPL (>= 2.1)
2323
Encoding: UTF-8
24-
URL: https://future.tests.futureverse.org, https://github.com/HenrikBengtsson/future.tests
25-
BugReports: https://github.com/HenrikBengtsson/future.tests/issues
26-
RoxygenNote: 7.2.3
24+
URL: https://future.tests.futureverse.org, https://github.com/futureverse/future.tests
25+
BugReports: https://github.com/futureverse/future.tests/issues
26+
RoxygenNote: 7.3.2
2727
Roxygen: list(markdown = TRUE)

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22

33
<div id="badges"><!-- pkgdown markup -->
4-
<a href="https://CRAN.R-project.org/web/checks/check_results_future.tests.html"><img border="0" src="https://www.r-pkg.org/badges/version/future.tests" alt="CRAN check status"/></a> <a href="https://github.com/HenrikBengtsson/future.tests/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/HenrikBengtsson/future.tests/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a> <a href="https://codecov.io/gh/HenrikBengtsson/future.tests"><img border="0" src="https://codecov.io/gh/HenrikBengtsson/future.tests/branch/develop/graph/badge.svg" alt="Coverage Status"/></a> <a href="https://lifecycle.r-lib.org/articles/stages.html"><img border="0" src="man/figures/lifecycle-maturing-blue.svg" alt="Life cycle: maturing"/></a>
4+
<a href="https://CRAN.R-project.org/web/checks/check_results_future.tests.html"><img border="0" src="https://www.r-pkg.org/badges/version/future.tests" alt="CRAN check status"/></a> <a href="https://github.com/futureverse/future.tests/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/futureverse/future.tests/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a> <a href="https://app.codecov.io/gh/futureverse/future.tests"><img border="0" src="https://codecov.io/gh/futureverse/future.tests/branch/develop/graph/badge.svg" alt="Coverage Status"/></a> <a href="https://lifecycle.r-lib.org/articles/stages.html"><img border="0" src="man/figures/lifecycle-maturing-blue.svg" alt="Life cycle: maturing"/></a>
55
<a href="https://www.r-consortium.org/projects/awarded-projects"><img border="0" src="man/figures/R_Consortium-logo-horizontal-white-purple-badge.svg" alt="R Consortium: ISC Project 2017-2"/></a>
66
</div>
77

@@ -57,7 +57,7 @@ install.packages("future.tests")
5757

5858
To install the pre-release version that is available in Git branch `develop` on GitHub, use:
5959
```r
60-
remotes::install_github("HenrikBengtsson/future.tests", ref="develop")
60+
remotes::install_github("futureverse/future.tests", ref="develop")
6161
```
6262
This will install the package from source.
6363

pkgdown/_pkgdown.yml

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,33 @@ home:
66
href: https://github.com/HenrikBengtsson/future.tests/milestones
77
- text: The Futureverse Project
88
href: https://www.futureverse.org/
9-
- text: Futureverse User Forum (new!)
9+
- text: Futureverse User Forum
1010
href: https://github.com/HenrikBengtsson/future/discussions
1111

1212
navbar:
1313
structure:
1414
right: [futureverse, pkgs, cran, github]
1515
components:
1616
futureverse:
17-
icon: fas fa-fast-backward
17+
icon: fas fa-home
1818
href: https://www.futureverse.org/
1919
pkgs:
2020
text: Packages
2121
menu:
22-
- text: BiocParallel.FutureParam
23-
href: https://BiocParallel.FutureParam.futureverse.org
24-
- text: doFuture
22+
- text: doFuture (map-reduce)
2523
href: https://doFuture.futureverse.org
26-
- text: furrr
24+
- text: furrr (map-reduce)
2725
href: https://furrr.futureverse.org
2826
- text: future
2927
href: https://future.futureverse.org
30-
- text: future.apply
28+
- text: future.apply (map-reduce)
3129
href: https://future.apply.futureverse.org
32-
- text: future.batchtools
30+
- text: future.batchtools (backend)
3331
href: https://future.batchtools.futureverse.org
34-
- text: future.callr
32+
- text: future.callr (backend)
3533
href: https://future.callr.futureverse.org
34+
- text: future.mirai (backend)
35+
href: https://future.mirai.futureverse.org
3636
- text: future.tests
3737
href: https://future.tests.futureverse.org
3838
- text: globals
@@ -43,6 +43,10 @@ navbar:
4343
href: https://parallelly.futureverse.org
4444
- text: progressr
4545
href: https://progressr.futureverse.org
46+
- text: BiocParallel.FutureParam (experimental)
47+
href: https://BiocParallel.FutureParam.futureverse.org
48+
- text: future.tools (experimental)
49+
href: https://future.tools.futureverse.org
4650
- text: future.mapreduce (experimental)
4751
href: https://future.mapreduce.futureverse.org
4852
- text: marshal (experimental)

pkgdown/_pkgdown.yml.rsp

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<%
2-
pkgs <- c("globals", "listenv", "parallelly", "future", "future.apply", "furrr", "future.tests", "future.callr", "future.batchtools", "doFuture", "progressr", "BiocParallel.FutureParam")
3-
pkgs_extra <- c("future.mapreduce", "marshal")
2+
pkgs_mapreduce <- c("future.apply", "doFuture", "furrr")
3+
pkgs_backend <- c("future.batchtools", "future.callr", "future.mirai")
4+
pkgs <- c("globals", "listenv", "parallelly", "future", "future.tests", "progressr", pkgs_mapreduce, pkgs_backend)
5+
pkgs_extra <- c("BiocParallel.FutureParam", "future.tools", "future.mapreduce", "marshal")
46
pkgs <- c(sort(pkgs), pkgs_extra)
57
urls <- sprintf("https://%s.futureverse.org", pkgs)
68
names(urls) <- pkgs
@@ -16,24 +18,24 @@ url: https://<%= pkg %>.futureverse.org
1618
home:
1719
links:
1820
- text: Roadmap/Milestones
19-
href: https://github.com/HenrikBengtsson/<%= pkg %>/milestones
21+
href: https://github.com/<%= gsub("(^.*:|[.]git$)", "", subset(gert::git_remote_list(), name == "origin")$url) %>/milestones
2022
- text: The Futureverse Project
2123
href: https://www.futureverse.org/
22-
- text: Futureverse User Forum (new!)
23-
href: https://github.com/HenrikBengtsson/future/discussions
24+
- text: Futureverse User Forum
25+
href: https://github.com/futureverse/future/discussions
2426

2527
navbar:
2628
structure:
2729
right: [futureverse, pkgs, cran, github]
2830
components:
2931
futureverse:
30-
icon: fas fa-fast-backward
32+
icon: fas fa-home
3133
href: https://www.futureverse.org/
3234
pkgs:
3335
text: Packages
3436
menu:
3537
<% for (name in names(urls)) { %>
36-
- text: <%= name %> <% if (name %in% pkgs_extra) { %>(experimental)<% } %>
38+
- text: <%= name %> <% if (name %in% pkgs_extra) { %>(experimental)<% } else if (name %in% pkgs_backend) { %>(backend)<% } else if (name %in% pkgs_mapreduce) { %>(map-reduce)<% } %>
3739
href: <%= urls[name] %>
3840
<% } %>
3941
cran:

vignettes/future.tests-01-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The **[future]** package defines the Future API which consists of a small number
1313

1414
> Write once, run anywhere
1515
16-
In order for such code to work regardless of which future backend the end-user choose, it is critical that the backend fully complies with the [Future API Backend Specification]. A future backend with A 100% compliance rate guarantees that the code will work equally well there as in sequential mode.
16+
In order for such code to work regardless of which future backend the end-user choose, it is critical that the backend fully complies with the [Future API Backend Specification]. A future backend with a 100% compliance rate guarantees that the code will work equally well there as in sequential mode.
1717

1818
This R package - **[future.tests]** - provides a test suite for validation that a future backend complies with the Future API.
1919

vignettes/future.tests-05-ci-github_actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ jobs:
118118
path: check
119119
```
120120
121-
For real-world examples, see the GitHub repositories of [**future**](https://github.com/HenrikBengtsson/future), [**future.batchtools**](https://github.com/HenrikBengtsson/future.batchtools), and [**future.callr**](https://github.com/HenrikBengtsson/future.callr).
121+
For real-world examples, see the GitHub repositories of [**future**](https://github.com/futureverse/future), [**future.batchtools**](https://github.com/futureverse/future.batchtools), and [**future.callr**](https://github.com/futureverse/future.callr).
122122
123123
[R]: https://www.r-project.org
124124
[future]: https://cran.r-project.org/package=future

0 commit comments

Comments
 (0)