mlr-org / mlr-org/batchtools

`loadRegistry` assigns exported objects into the global namespace

Open
#304 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
184
Forks
53
Avg merge
7d 2h
Merged PRs (30d)
1

Description

This is not documented in loadRegistry.
But as @berndbischl noted, it is documented in batchExport.

library(batchtools)
path = tempfile()
reg = makeExperimentRegistry(path)
#> No readable configuration file found
#> Created registry in '/var/folders/ft/n79895td0xn0gpr6ny8jyh800000gn/T/RtmpAFvW7R/file8eef2b73136b' using cluster functions 'Interactive'

batchExport(list(a = 123))
#> Exporting new objects: 'a' ...


a = 345

loadRegistry(path)
#> Reading registry in read-only mode.You can inspect results and errors, but cannot add, remove, submit or alter jobs in any way.If you need write-access, re-load the registry with `loadRegistry([...], writeable = TRUE)`.
#> No readable configuration file found
#> Experiment Registry
#>   Backend   : Interactive
#>   File dir  : /var/folders/ft/n79895td0xn0gpr6ny8jyh800000gn/T/RtmpAFvW7R/file8eef2b73136b
#>   Work dir  : /private/var/folders/ft/n79895td0xn0gpr6ny8jyh800000gn/T/RtmpJ9OtV1/reprex-8e786d06a68d-frail-tick
#>   Jobs      : 0
#>   Problems  : 0
#>   Algorithms: 0
#>   Seed      : 3916
#>   Writeable : FALSE

a
#> [1] 123

Created on 2024-12-02 with reprex v2.1.1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the loadRegistry documentation and compare it with the documented behavior of batchExport. Confirm that exported objects are assigned into the global namespace, then document that behavior in the loadRegistry entry so the two descriptions are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.