Package index • SpaDES.project

All functions
`SpaDES.project` `SpaDES.project-package`	Project templates using `SpaDES`
`as.data.table(<simLists>)`	Coerce elements of a `simLists` object to a `data.table`
`as_path()`	Render a scenario (or list of them) as the canonical output path.
`as_scenario()`	Coerce any scenario representation to a canonical record.
`as_tarname()`	Render a scenario as an upload tar filename.
`assessDoneInFigure()`	Assess simulation status from PNG outputs
`awaitExperimentFuture()`	Wait for all workers in an experimentFuture to finish
`awaitExperimentSBATCH()`	Wait for all SBATCH workers to finish
`.libPathDefault()`	SpaDES.project default .libPaths() directory
`experiment()`	Run an experiment using `SpaDES.core::spades()`
`experiment2()`	Run experiment, algorithm 2, using `SpaDES.core::spades()`
`experimentFuture()`	Run parallel R jobs using background processes (tmux-free)
`experimentFutureList()`	Find (and optionally kill) live experimentFuture workers
`experimentMonitor()`	Monitor live workers across an experiment (tmux panes or callr/cluster futures)
`experimentSBATCH()`	Run parallel R jobs on a Slurm cluster (SBATCH-based)
`experimentTmux()`	Spawn tmux worker panes and process a job queue
`experiment_family`	Experiment functions: five ways to run a SpaDES experiment
`factorialDesign()`	Build a factorial experiment design
`findProjectPath()` `findProjectName()`	Find the project root directory
`getGithubFile()`	A simple way to get a Github file, authenticated
`getModule()`	Simple function to download a SpaDES module as GitHub repository
`get_sim_year_heartbeat()`	Heartbeat for year-checkpoint SpaDES simulations
`user()` `machine()` `node()`	Helpers to develop easier to understand code.
`initialize(<simLists>)`	Generate a `simLists` object
`killExperimentFuture()`	Stop workers launched by experimentFuture
`killExperimentSBATCH()`	Stop SBATCH workers launched by experimentSBATCH
`lastTraceback()`	Inspect the call stack from the most recent worker error
`listModules()` `moduleDependencies()` `moduleDependenciesToGraph()` `PlotModuleGraph()`	Tools for examining modules on known repositories
`localHostLabel()`	Short friendly name for the local machine
`makeDESCRIPTIONproject()` `makeDESCRIPTION()`	Make DESCRIPTION file(s) from SpaDES module metadata
`packagesInModules()` `metadataInModules()`	Extract element from SpaDES module metadata
`outList()`	List uploaded scenario output archives.
`outSave()`	Save a SpaDES simulation to an RDS file
`outSaveTarUpload()`	Save, tar, and upload a SpaDES simulation to Google Drive
`outScenarios()`	Uploaded outputs as scenario records.
`outTar()`	Bundle a sim file and output files into a tar.gz archive
`outUpload()`	Upload a file to Google Drive
`pathBuild()`	Default scenario path builder.
`pathParse()`	Default scenario path parser.
`pkgload2()`	An alternative to `pkgload::load_all` with caching
`plotSAs()` `plotSAsLeaflet()`	Plot studyArea and rasterToMatch with ggplot2 or leaflet
`preRunSetupProject()`	Partially or Fully Run `setupProject`
`queueRead()`	Read the driver queue (local RDS or Google Sheet).
`queueUploadMissing()`	Queue rows whose tarball is missing from the upload folder.
`reGet()`	Download tarballs from Google Drive
`reGetUntarLoad()`	Download, untar, and load SpaDES sims from Google Drive
`reLoad()`	Load saved SpaDES simLists
`reUntar()`	Extract sim tarballs, optionally remapping a path prefix
`register_scenario_format()`	Register a project-specific path builder / parser.
`runWorkerLoopFuture()`	Worker loop for future/cluster-based remote execution
`scenario()`	Construct a scenario record.
`scenarioFields()` `scenarioFieldsSet()`	Active scenario field labels.
`scenario_family`	Scenario records: one canonical form, multiple representations
`setProjPkgDir()`	Set the package directory for a project
`setupFiles()`	Parse a list of (possibly remote) R / config files
`setupFunctions()`	Source user-supplied helper functions into the project environment
`setupGitIgnore()`	Add `packagePath` and/or `modulePath` to the project's `.gitignore`
`setupModules()`	Download (or git clone) SpaDES modules into the project's `modulePath`
`setupOptions()`	Apply (and stage) project options
`setupPackages()`	Install module + user-supplied R packages into the project library
`setupParams()`	Prepare module parameter lists for `simInit()`
`setupPaths()`	Set up project, module, and scratch paths
`setupProject()`	Sets up a new or existing SpaDES project
`setupSideEffects()`	Run side-effect scripts (e.g., authentication, custom package options)
`setupStudyArea()`	Resolve a study area from a `studyArea` spec via `geodata::gadm()`
`show(<simLists>)`	Show method for `simLists`
`simInitAndExperiment()`	Run `simInit` and `experiment` in one step
`simLists-class` `simLists`	The `simLists` class
`spadesProjectOptions()`	`SpaDES.project` options
`statusCalculate_FireSenseFit` `statusCalculate_LandR`	Pre-built statusCalculate expressions for experimentTmux / experimentFuture
`teardownProject()`	Tear down a project created by `setupProject()`
`tmuxActiveRunningPath()`	Log path for default tmux status
`tmuxFindDuplicates()`	Find duplicate worker panes running the same job
`tmuxKillPanes()`	Kill a set of tmux panes (e.g., those spawned by experimentTmux)
`tmuxListPanes()`	List all tmux panes on this machine across every tmux server
`tmuxMirrorQueueToSheets()`	Mirror local queue to Google Sheets
`tmuxPrepareQueueFromDF()`	Initialize a file-backed queue from a data.frame
`tmuxRefreshQueueStatus()`	Refresh and Assess Queue Status from Simulation Outputs
`tmuxRunNextWorker()`	Run one queued job (claim-next semantics) in the current R session.
`tmuxRunWorkerLoop()`	Run queued jobs repeatedly (pane-local loop).
`tmuxSetMouse()`	Enable or disable tmux mouse interaction
`tmuxSetPaneTitle()`	Set a tmux pane's title by matching its current title

Reference

All functions