Contents
workspace
Active PolyGenius workspace
The runtime context generate, compute, associate, evaluate and
visualize all resolve against: configuration, resource catalogs,
external-tool setup and execution internals. Created by .onLoad.
Usage
workspaceValue
An environment of class PolyGeniusWorkspace with members config,
catalogs, setup and .internal.
Details
Four members, each read-only — assigning to one aborts.
workspace$config— runtime settings, listed below; change them withworkspace$config$update(...).workspace$catalogs— GenomeBuilds, ReferencePanels, VariantSpaces, LiftoverChains, LDblocks and LDs.workspace$setup— external tool management:install(),check(),status()andget()for PLINK2, GCTB, the PRS-CS Python environment and the bigsnpr R stack.workspace$.internal—store,resolver,executorandrules, for extension authors.
Configuration fields
Each field is read-only and changed only through workspace$config$update().
Many functions resolve a NULL argument from one of them.
root— character scalar path, defaulttools::R_user_dir("PolyGenius", "cache"). Cache and output root; every cached resource lives beneath it.log.dir— character scalar path, derived asfile.path(root, "logs"). General log directory; not settable on its own.execution.dir— character scalar path, derived asfile.path(root, "execution"). Execution-engine log and state directory; not settable on its own.max.cores— positive integer,Inf, orNULL; defaultNULL. Engine worker cap;NULLandInfboth resolve to detected cores minus one.max.memory— positive numeric scalar in GiB, orInf; defaultInf. Engine memory budget. A value strictly between 0 and 1 is rejected as a unit error.max.model.column.bytes— positive numeric scalar in bytes, orInf; default4294967296(4 GiB). Byte budget on the column(s) a singlemutate.variants()call materializes.max.absorb.batch.models— positive integer, orInf; default50. How many modelsgenerate$models()folds into onePolyGeniusBackbone$absorb()call while collecting results.oversubscribe— logical scalar, defaultFALSE. WhenTRUE, an explicit finitemax.coresis honored above the detected-core cap.verbosity— one of"fatal","error","warn","info","debug","trace","all","off"; default"info". Console logger threshold.execution.status— one of"auto","yes","no"; default"yes". Execution status display mode.execution.log.propagate— one of"yes","no"; default"no". Whether execution logs propagate to the parent logger.palette— one of"polygenius","nature-npg"; default"polygenius". Plot palette system applied by default across everyvisualizefunction; a per-plotpaletteargument overrides it.dashboard.live— one of"auto","yes","no"; default"auto". Whether to auto-host a live execution dashboard.