Skip to content

Commit 041d240

Browse files
Updated 'gh-pages' from docs/ folder
1 parent 4c513ca commit 041d240

50 files changed

Lines changed: 231 additions & 244 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: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

CONDUCT.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

CONTRIBUTING.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

OVERVIEW.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

articles/future.batchtools.html

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

articles/future.batchtools.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22

33
## TL;DR
44

5-
Here is an example on how to evaluate R expressions on a Slurm
6-
high-performance compute (HPC) cluster from within R.
5+
Here is an example of how to evaluate R expressions on a Slurm
6+
high-performance computing (HPC) cluster from within R.
77

88
``` r
9-
109
library(future)
1110

1211
# Limit runtime to 10 minutes and memory to 400 MiB per future,
@@ -55,12 +54,11 @@ leverage the compute power of high-performance computing (HPC) clusters
5554
via a simple switch in settings - without having to change any code at
5655
all.
5756

58-
For instance, the below two future R expressions will be processed by
59-
parallel R workers that launched on different compute nodes by the
57+
For instance, the following two future R expressions will be processed
58+
by parallel R workers launched on different compute nodes by the
6059
specified job scheduler:
6160

6261
``` r
63-
6462
library(future)
6563
plan(future.batchtools::batchtools_slurm)
6664

@@ -89,26 +87,25 @@ used. *The user has full control of how futures are evaluated*. For
8987
instance, to use local batchtools futures, run the demo as:
9088

9189
``` r
92-
9390
library(future)
9491
plan(future.batchtools::batchtools_local)
9592
demo("mandelbrot", package = "future", ask = FALSE)
9693
```
9794

98-
## Available batchtools backend
95+
## Available batchtools backends
9996

10097
The **future.batchtools** package implements a generic future wrapper
10198
for all batchtools backends. Below are the most common types of
10299
batchtools backends. For other types of parallel and distributed
103100
backends, please see <https://www.futureverse.org/backends.html>.
104101

105-
| Backend | Description | Alternative in future package |
106-
|:---|:---|:---|
107-
| `batchtools_lsf` | Futures are evaluated via a [Load Sharing Facility (LSF)](https://en.wikipedia.org/wiki/Platform_LSF) job scheduler | N/A |
108-
| `batchtools_openlava` | Futures are evaluated via an [OpenLava](https://en.wikipedia.org/wiki/OpenLava) job scheduler | N/A |
109-
| `batchtools_sge` | Futures are evaluated via a [Sun/Son of/Oracle/Univa/Altair Grid Engine (SGE)](https://en.wikipedia.org/wiki/Oracle_Grid_Engine) job scheduler | N/A |
110-
| `batchtools_slurm` | Futures are evaluated via a [Slurm](https://en.wikipedia.org/wiki/Slurm_Workload_Manager) job scheduler | N/A |
111-
| `batchtools_torque` | Futures are evaluated via a [TORQUE](https://en.wikipedia.org/wiki/TORQUE) / PBS job scheduler | N/A |
112-
| `batchtools_custom` | Futures are evaluated via a custom batchtools configuration R script or via a set of cluster functions | N/A |
113-
| `batchtools_multicore` | parallel evaluation by forking the current R process | `plan(multicore)` |
114-
| `batchtools_local` | sequential evaluation in a separate R process (on current machine) | `plan(cluster, workers = I(1))` |
102+
| Backend | Description | Alternative in future package |
103+
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------|
104+
| `batchtools_lsf` | Futures are evaluated via a [Load Sharing Facility (LSF)](https://en.wikipedia.org/wiki/Platform_LSF) job scheduler | N/A |
105+
| `batchtools_openlava` | Futures are evaluated via an [OpenLava](https://en.wikipedia.org/wiki/OpenLava) job scheduler | N/A |
106+
| `batchtools_sge` | Futures are evaluated via a [Sun/Son of/Oracle/Univa/Altair Grid Engine (SGE)](https://en.wikipedia.org/wiki/Oracle_Grid_Engine) job scheduler | N/A |
107+
| `batchtools_slurm` | Futures are evaluated via a [Slurm](https://en.wikipedia.org/wiki/Slurm_Workload_Manager) job scheduler | N/A |
108+
| `batchtools_torque` | Futures are evaluated via a [TORQUE](https://en.wikipedia.org/wiki/TORQUE) / PBS job scheduler | N/A |
109+
| `batchtools_custom` | Futures are evaluated via a custom batchtools configuration R script or via a set of cluster functions | N/A |
110+
| `batchtools_multicore` | parallel evaluation by forking the current R process | `plan(multicore)` |
111+
| `batchtools_local` | sequential evaluation in a separate R process (on current machine) | `plan(cluster, workers = I(1))` |

articles/index.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

authors.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

index.html

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

0 commit comments

Comments
 (0)