Skip to content

Commit 75ef23f

Browse files
authored
docs: fix absolute urls in vigngette (#320)
1 parent d149bbf commit 75ef23f

File tree

4 files changed

+136
-134
lines changed

4 files changed

+136
-134
lines changed

DESCRIPTION

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,30 @@ Package: batchtools
22
Title: Tools for Computation on Batch Systems
33
Version: 0.9.18
44
Authors@R: c(
5-
person("Michel", "Lang", NULL, "michellang@gmail.com",
6-
role = c("cre", "aut"), comment = c(ORCID = "0000-0001-9754-0393")),
7-
person("Bernd", "Bischl", NULL, "bernd_bischl@gmx.net", role = "aut"),
8-
person("Dirk", "Surmann", NULL, "surmann@statistik.tu-dortmund.de",
9-
role = "ctb", comment = c(ORCID = "0000-0003-0873-137X"))
10-
)
11-
Description: As a successor of the packages 'BatchJobs' and 'BatchExperiments',
12-
this package provides a parallel implementation of the Map function for high
13-
performance computing systems managed by schedulers 'IBM Spectrum LSF'
14-
(<https://www.ibm.com/products/hpc-workload-management>),
15-
'OpenLava' (<https://www.openlava.org/>), 'Univa Grid Engine'/'Oracle Grid
16-
Engine' (<https://www.univa.com/>), 'Slurm' (<https://slurm.schedmd.com/>),
17-
'TORQUE/PBS'
5+
person("Michel", "Lang", , "michellang@gmail.com", role = c("cre", "aut"),
6+
comment = c(ORCID = "0000-0001-9754-0393")),
7+
person("Bernd", "Bischl", , "bernd_bischl@gmx.net", role = "aut"),
8+
person("Dirk", "Surmann", , "surmann@statistik.tu-dortmund.de", role = "ctb",
9+
comment = c(ORCID = "0000-0003-0873-137X"))
10+
)
11+
Description: As a successor of the packages 'BatchJobs' and
12+
'BatchExperiments', this package provides a parallel implementation of
13+
the Map function for high performance computing systems managed by
14+
schedulers 'IBM Spectrum LSF'
15+
(<https://www.ibm.com/products/hpc-workload-management>), 'Univa Grid
16+
Engine'/'Oracle Grid Engine'
17+
(<https://altair.com/hpc-cloud-applications/>), 'Slurm'
18+
(<https://slurm.schedmd.com/>), 'TORQUE/PBS'
1819
(<https://adaptivecomputing.com/cherry-services/torque-resource-manager/>),
19-
or 'Docker Swarm' (<https://docs.docker.com/engine/swarm/>).
20-
A multicore and socket mode allow the parallelization on a local machines,
21-
and multiple machines can be hooked up via SSH to create a makeshift
22-
cluster. Moreover, the package provides an abstraction mechanism to define
23-
large-scale computer experiments in a well-organized and reproducible way.
20+
or 'Docker Swarm' (<https://docs.docker.com/engine/swarm/>). A
21+
multicore and socket mode allow the parallelization on a local
22+
machines, and multiple machines can be hooked up via SSH to create a
23+
makeshift cluster. Moreover, the package provides an abstraction
24+
mechanism to define large-scale computer experiments in a
25+
well-organized and reproducible way.
2426
License: LGPL-3
2527
URL: https://github.com/mlr-org/batchtools, https://batchtools.mlr-org.com
2628
BugReports: https://github.com/mlr-org/batchtools/issues
27-
NeedsCompilation: yes
28-
ByteCompile: yes
29-
Encoding: UTF-8
3029
Depends:
3130
R (>= 3.0.0)
3231
Imports:
@@ -47,8 +46,8 @@ Imports:
4746
withr (>= 2.0.0)
4847
Suggests:
4948
debugme,
50-
doParallel,
5149
doMPI,
50+
doParallel,
5251
e1071,
5352
foreach,
5453
future,
@@ -61,6 +60,10 @@ Suggests:
6160
snow,
6261
testthat,
6362
tibble
64-
VignetteBuilder: knitr
63+
VignetteBuilder:
64+
knitr
65+
ByteCompile: yes
66+
Encoding: UTF-8
67+
NeedsCompilation: yes
6568
Roxygen: list(r6 = FALSE)
6669
RoxygenNote: 7.3.2

README.Rmd

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Package website: [release](https://batchtools.mlr-org.com/) | [dev](https://batc
1414
[![Mattermost](https://img.shields.io/badge/chat-mattermost-orange.svg)](https://lmmisld-lmu-stats-slds.srv.mwn.de/mlr_invite/)
1515
<!-- badges: end -->
1616

17-
As a successor of the packages [BatchJobs](https://github.com/tudo-r/BatchJobs) and [BatchExperiments](https://github.com/tudo-r/Batchexperiments), batchtools provides a parallel implementation of Map for high performance computing systems managed by schedulers like Slurm, Sun Grid Engine, OpenLava, TORQUE/OpenPBS, Load Sharing Facility (LSF) or Docker Swarm (see the setup section in the [vignette](https://batchtools.mlr-org.com/batchtools/articles/batchtools.html)).
17+
As a successor of the packages [BatchJobs](https://github.com/tudo-r/BatchJobs) and [BatchExperiments](https://github.com/tudo-r/Batchexperiments), batchtools provides a parallel implementation of Map for high performance computing systems managed by schedulers like Slurm, Sun Grid Engine, OpenLava, TORQUE/OpenPBS, Load Sharing Facility (LSF) or Docker Swarm (see the setup section in the [vignette](https://batchtools.mlr-org.com/articles/batchtools.html)).
1818

1919
Main features:
2020

@@ -37,7 +37,7 @@ devtools::install_github("mlr-org/batchtools")
3737
```
3838

3939
Next, you need to setup `batchtools` for your HPC (it will run sequentially otherwise).
40-
See the [vignette](https://mlr-org.github.io/batchtools/articles/batchtools.html#setup) for instructions.
40+
See the [vignette](https://batchtools.mlr-org.com/articles/batchtools.html) for instructions.
4141

4242
## Why batchtools?
4343
The development of [BatchJobs](https://github.com/tudo-r/BatchJobs/) and [BatchExperiments](https://github.com/tudo-r/Batchexperiments) is discontinued for the following reasons:
@@ -46,15 +46,14 @@ The development of [BatchJobs](https://github.com/tudo-r/BatchJobs/) and [BatchE
4646
* Data base issues: Although we invested weeks to mitigate issues with locks of the SQLite data base or file system (staged queries, file system timeouts, ...), `BatchJobs` kept working unreliable on some systems with high latency under certain conditions. This made `BatchJobs` unusable for many users.
4747

4848
[BatchJobs](https://github.com/tudo-r/BatchJobs/) and [BatchExperiments](https://github.com/tudo-r/Batchexperiments) will remain on CRAN, but new features are unlikely to be ported back.
49-
The [vignette](https://batchtools.mlr-org.com/batchtools/articles/batchtools.html#migration) contains a section comparing the packages.
49+
The [vignette](https://batchtools.mlr-org.com/articles/batchtools.html) contains a section comparing the packages.
5050

5151

5252
## Resources
53-
* [NEWS](https://batchtools.mlr-org.com/batchtools/news/)
54-
* [Function reference](https://batchtools.mlr-org.com/batchtools/reference/)
55-
* [Vignette](https://batchtools.mlr-org.com/batchtools/articles/batchtools.html)
53+
* [Function reference](https://batchtools.mlr-org.com/reference/)
54+
* [Vignette](https://batchtools.mlr-org.com/articles/batchtools.html)
5655
* [JOSS Paper](https://doi.org/10.21105/joss.00135): Short paper on batchtools. Please cite this if you use batchtools.
57-
* [Paper on BatchJobs/BatchExperiments](https://www.jstatsoft.org/v64/i11): The described concept still holds for batchtools and most examples work analogously (see the [vignette](https://batchtools.mlr-org.com/batchtools/articles/batchtools.html#migration) for differences between the packages).
56+
* [Paper on BatchJobs/BatchExperiments](https://www.jstatsoft.org/v64/i11): The described concept still holds for batchtools and most examples work analogously (see the [vignette](https://batchtools.mlr-org.com/articles/batchtools.html) for differences between the packages).
5857

5958
## Citation
6059
Please cite the [JOSS paper](https://doi.org/10.21105/joss.00135) using the following BibTeX entry:

_pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ toc:
1616

1717
navbar:
1818
structure:
19-
left: [reference, news, book]
19+
left: [reference, news, articles, book]
2020
right: [search, github, mattermost, stackoverflow, rss, lightswitch]
2121
components:
2222
home: ~

0 commit comments

Comments
 (0)