Skip to content

Commit 1c8bc43

Browse files
README: tweaks [ci skip]
1 parent 3064d10 commit 1c8bc43

File tree

2 files changed

+22
-20
lines changed

2 files changed

+22
-20
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ expressions for futures `x` and `y` will be processed on two different
2828
compute nodes:
2929

3030
```r
31-
> library(future.batchtools)
32-
> plan(batchtools_slurm)
33-
>
34-
> x %<-% { Sys.sleep(5); 3.14 }
35-
> y %<-% { Sys.sleep(5); 2.71 }
36-
> x + y
37-
[1] 5.85
31+
library(future)
32+
planb(future.batchtools::atchtools_slurm)
33+
34+
x %<-% { Sys.sleep(5); 3.14 }
35+
y %<-% { Sys.sleep(5); 2.71 }
36+
x + y
37+
#> [1] 5.85
3838
```
3939

4040
This is just a toy example to illustrate what futures look like and
@@ -53,12 +53,13 @@ could be implemented using futures.
5353
```r
5454
library(future)
5555
library(listenv)
56+
5657
## The first level of futures should be submitted to the
5758
## cluster using batchtools. The second level of futures
5859
## should be using multisession, where the number of
5960
## parallel processes is automatically decided based on
6061
## what the cluster grants to each compute node.
61-
plan(list(batchtools_slurm, multisession))
62+
plan(list(future.batchtools::batchtools_slurm, multisession))
6263

6364
## Find all samples (one FASTQ file per sample)
6465
fqs <- dir(pattern = "[.]fastq$")
@@ -212,8 +213,8 @@ futures are evaluated_. For instance, to use local batchtools
212213
futures, run the demo as:
213214

214215
```r
215-
library(future.batchtools)
216-
plan(batchtools_local)
216+
library(future)
217+
plan(future.batchtools::batchtools_local)
217218
demo("mandelbrot", package = "future", ask = FALSE)
218219
```
219220

vignettes/future.batchtools.md.rsp

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ expressions for futures `x` and `y` will be processed on two different
4141
compute nodes:
4242

4343
```r
44-
> library(future.batchtools)
45-
> plan(batchtools_slurm)
46-
>
47-
> x %<-% { Sys.sleep(5); 3.14 }
48-
> y %<-% { Sys.sleep(5); 2.71 }
49-
> x + y
50-
[1] 5.85
44+
library(future)
45+
planb(future.batchtools::atchtools_slurm)
46+
47+
x %<-% { Sys.sleep(5); 3.14 }
48+
y %<-% { Sys.sleep(5); 2.71 }
49+
x + y
50+
#> [1] 5.85
5151
```
5252

5353
This is just a toy example to illustrate what futures look like and
@@ -66,12 +66,13 @@ could be implemented using futures.
6666
```r
6767
library(future)
6868
library(listenv)
69+
6970
## The first level of futures should be submitted to the
7071
## cluster using batchtools. The second level of futures
7172
## should be using multisession, where the number of
7273
## parallel processes is automatically decided based on
7374
## what the cluster grants to each compute node.
74-
plan(list(batchtools_slurm, multisession))
75+
plan(list(future.batchtools::batchtools_slurm, multisession))
7576

7677
## Find all samples (one FASTQ file per sample)
7778
fqs <- dir(pattern = "[.]fastq$")
@@ -226,8 +227,8 @@ futures are evaluated_. For instance, to use local batchtools
226227
futures, run the demo as:
227228

228229
```r
229-
library(future.batchtools)
230-
plan(batchtools_local)
230+
library(future)
231+
plan(future.batchtools::batchtools_local)
231232
demo("mandelbrot", package = "future", ask = FALSE)
232233
```
233234

0 commit comments

Comments
 (0)