Skip to content

Commit 25c8d28

Browse files
Updated 'gh-pages' from docs/ folder
1 parent 57f8c17 commit 25c8d28

57 files changed

Lines changed: 1674 additions & 245 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

404.html

Lines changed: 7 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

404.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Content not found. Please use links in the navbar.
2+
3+
# Page not found (404)

CONTRIBUTING.html

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing to the ‘future.tests’ package
2+
3+
This Git repository uses the [Git
4+
Flow](https://nvie.com/posts/a-successful-git-branching-model/)
5+
branching model (the
6+
[`git flow`](https://github.com/petervanderdoes/gitflow-avh) extension
7+
is useful for this). The
8+
[`develop`](https://github.com/futureverse/future.tests/tree/develop)
9+
branch contains the latest contributions and other code that will appear
10+
in the next release, and the
11+
[`master`](https://github.com/futureverse/future.tests) branch contains
12+
the code of the latest release, which is exactly what is currently on
13+
[CRAN](https://cran.r-project.org/package=future.tests).
14+
15+
Contributing to this package is easy. Just send a [pull
16+
request](https://help.github.com/articles/using-pull-requests/). When
17+
you send your PR, make sure `develop` is the destination branch on the
18+
[future.tests repository](https://github.com/futureverse/future.tests).
19+
Your PR should pass `R CMD check --as-cran`, which will also be checked
20+
by [GitHub
21+
Actions](https://github.com/futureverse/future.tests/actions?query=workflow%3AR-CMD-check)
22+
and when the PR is submitted.
23+
24+
We abide to the [Code of
25+
Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)
26+
of Contributor Covenant.

OVERVIEW.html

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

OVERVIEW.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# NA
2+
3+
The **[future](https://future.futureverse.org)** package defines the
4+
Future API which consists of a small number of functions for writing
5+
[R](https://www.r-project.org) code that can be evaluated either
6+
sequential or in parallel based a single setting without having to
7+
change anything in the code. Parallelization can be done via one of many
8+
backends, e.g. via built-in multicore, multisession and cluster backends
9+
(based on the **parallel** package) or via third-party backends such as
10+
**[future.batchtools](https://future.batchtools.futureverse.org)**,
11+
**[future.callr](https://future.callr.futureverse.org)** and
12+
**[future.mirai](https://future.mirai.futureverse.org)**. The design
13+
motto of the Future API is:
14+
15+
> Write once, run anywhere
16+
17+
In order for such code to work regardless of which future backend the
18+
end-user choose, it is critical that the backend fully complies with the
19+
[Future API Backend
20+
Specification](https://future.futureverse.org/articles/future-6-future-api-backend-specification.html).
21+
A future backend with a 100% compliance rate guarantees that the code
22+
will work equally well there as in sequential mode.
23+
24+
This R package -
25+
**[future.tests](https://future.tests.futureverse.org)** - provides a
26+
test suite for validation that a future backend complies with the Future
27+
API.
28+
29+
![](articles/imgs/screencast.gif)
30+
31+
## Validate a Future Backend
32+
33+
All future backends implementing the Future API should validate that
34+
they conform to the Future API. This can be done using the
35+
**[future.tests](https://future.tests.futureverse.org)** package, which
36+
provides two API for running the tests. The tests can be performed
37+
either from within R or from outside of R from the command line making
38+
it easy to include them package tests and in Continuous Integration (CI)
39+
pipelines.
40+
41+
### From Within R
42+
43+
``` r
44+
> results <- future.tests::check(plan = "multisession")
45+
> exit_code <- attr(results, "exit_code")
46+
> if (exit_code != 0) stop("One or more tests failed")
47+
```
48+
49+
### From Outside R
50+
51+
``` sh
52+
$ Rscript -e future.tests::check --test-plan="multisession"
53+
$ exit_code=$?
54+
$ [[ exit_code -eq 0 ]] || { >&2 echo "One or more tests failed"; exit 1; }
55+
```

articles/future.tests-01-intro.html

Lines changed: 8 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)