makeClusterFunctions store.job.collection flag documentation
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 184
- Forks
- 53
- Avg merge
- 7d 2h
- Merged PRs (30d)
- 1
Description
The makeClusterFunctions documentation for the store.jobs.collection flag says
If set to
FALSE, theJobCollectionis serialized to the file system before submitting the job.
But I assume exactly the opposite is the case, given e.g. https://github.com/mllg/batchtools/blob/4c2a476725452e742ed59b9a45457723cd398ab2/R/submitJobs.R#L278-L279 ?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the makeClusterFunctions documentation and the referenced lines in R/submitJobs.R, especially around the store.jobs.collection flag. Verify whether the documented TRUE/FALSE behavior matches the implementation, then correct the flag description so the documentation accurately states when the JobCollection is serialized.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100