Skip to content

Add example Rscripts for real-world workflows (multicore, SLURM) #30

@natalie-23-gill

Description

@natalie-23-gill

Problem

The quickstart vignette uses plan("multisession") which won't work for real datasets due to memory copying. New users don't have a clear template for how to actually run clustOpt in production.

Proposal

Add ready-to-adapt Rscript templates in inst/scripts/:

  • run_clustopt_multicore.R — local machine with plan("multicore")
  • run_clustopt_slurm.R — HPC with future.batchtools

These should show the real-world pattern: load data → sketch → free original object → SCTransform → PCA → run clust_opt → save results.

Users can copy and adapt these rather than translating the vignette.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions