Package index • parade

All functions

account(): Set account for a resource profile
args(): Auto-detect argument type
args_call(): Create argument list for function calls
args_cli(): Create argument list for CLI scripts
artifact(): Alias for file_ref function
artifact_catalog(): Artifact catalog utilities
artifact_catalog_search(): Search an artifact catalog
as.list(<parade_profile>): Convert profile to list for slurm_resources()
as_jobset(): Convert a job or list of jobs to a jobset
as_tibble(<parade_jobset>): Convert jobset to tibble
await(): Wait for jobs to complete
balance_by(): Balance work across groups
batch_resources(): Create a list of SLURM resources with friendly parsing
blob(): Create a blob type specification
c(<parade_jobset>): Combine jobsets
cancel(): Cancel all jobs in a jobset
chr(): Create a character type specification
chunk_by(): Chunk data into groups
collect(): Collect results from all jobs in a jobset
collect(<parade_flow>): Execute a parade flow and collect results
collect_result(): Collect results from a job
combine_grids(): Combine multiple grids
completed(): Select completed jobs
contract(): Define a validation contract for stage outputs
cpus(): Set CPU count for a resource profile
ctr_field(): Define a contract field specification
dbl(): Create a double/numeric type specification
deferred_await(): Wait for deferred execution to complete
deferred_cancel(): Cancel deferred execution jobs
deferred_collect(): Collect results from deferred execution
deferred_status(): Get status of a deferred execution
diagnostics(): Extract diagnostic information from flow results
digest(): Generate job names from content digest
dist_crew(): Create crew distribution specification
dist_local(): Create local distribution specification
dist_mirai(): Create mirai distribution specification
dist_slurm(): Create SLURM distribution specification
dist_slurm_allocation(): Convenience: SLURM distribution from an allocation shape
dist_slurm_profile(): Convenience: SLURM distribution from a named profile
distribute(): Add distribution settings to a parade flow
dry_run(): Dry run job submission
dry_run(<default>): Dry run for job submission (default)
dry_run(<parade_flow>): Dry-run a flow: show plan and counts without executing
expand_path_macros_enhanced(): Expand path macros with enhanced patterns
explain(): Explain what will be executed
explain(<default>): Explain a job submission (default)
explain(<parade_flow>): Explain a flow: DAG + distribution + sinks
failed(): Select failed jobs
failed(<data.frame>): Extract failed rows from flow results
file_ref(): Create a file reference type specification
flow(): Create a parade flow for declarative data processing
flow_control(): Combine flow control policies
get_arg(): Retrieve a command-line argument
get_errors(): Get collected errors from a policy
get_sink_format(): Get a registered sink format
glob(): Glob file patterns
glue_name(): Generate job names using glue-style templates
gpus(): Set GPU count for a resource profile
grid(): Create parameter grid for job submission
guard_packages(): Guard that required packages are available
has_sink_format(): Check if a sink format is registered
in_waves_of(): Submit jobs in waves with controlled parallelism
index(): Generate job names from indices
int(): Create an integer type specification
is_done(): Check if a job is done
is_flow_control(): Check if object is a flow control policy
isa(): Create a class-based type specification
job_status(): Get job status
jobs_top(): Live dashboard for multiple SLURM jobs
length(<parade_jobset>): Get length of jobset
lgl(): Create a logical type specification
lhs_grid(): Create a Latin hypercube sample for parameter exploration
list_sink_formats(): List registered sink formats
list_submit_backends(): List available submit backends
lst(): Create a list type specification
manifest(): Create artifact manifest from sidecar files
max_in_flight(): Limit maximum concurrent jobs
maybe(): Create an optional type specification
maybe_neurovol(): Optional neuroimaging volume
mem(): Set memory limit for a resource profile
mirai_available(): Check mirai availability
mirai_dispatcher_status(): Get mirai dispatcher status
mirai_init(): Initialize mirai for parade
mirai_scale(): Scale mirai daemons
mirai_status(): Get mirai daemon status
mirai_stop(): Stop all mirai daemons
name_by(): Create a custom naming function
name_digest(): Alias for digest-based naming that avoids masking digest::digest
neurovol(): Neuroimaging volume type specification
`%||%`: Null-coalescing operator
omit(): Create an omit sentinel for resource removal
on_error(): Define error handling policy for jobs
on_error_retry(): Shorthand for retry error policy
one_of(): Create a union type specification
open_logs(): Open log files for a job
open_logs(<default>): Fallback log opener for list-like job objects
open_logs(<parade_jobset>): Open log files for a jobset
pack(): Pack a schema into a structured type
parade_config_path(): Locate the parade configuration file
parade_config_read(): Read parade configuration
parade_config_write(): Write parade configuration
parade_dashboard(): Unified dashboard for parade jobs
parade_doctor(): Quick setup checks for parade
parade_init_hpc(): Initialize parade for HPC use
parade_options(): Global parade options (get/set)
param_grid(): Create a parameter grid for flows
partition(): Set partition for a resource profile
path: Path object with convenient accessors
path_here(): Resolve a path using configured aliases
path_patterns: Common path patterns
path_template(): Create a path template builder
paths_export(): Generate shell exports for the current path configuration
paths_get(): Get current parade path configuration
paths_init(): Initialize parade path configuration
paths_set(): Set specific parade paths
paths_validate(): Validate parade path configuration
pending(): Select pending jobs
pipeline(): Create a parade pipeline (alias for flow)
pred(): Create a predicate-based type specification
preflight(): Preflight checks for a flow
print(<parade_error_policy>): Print method for error policies
print(<parade_flow>): Print method for parade flows
print(<parade_flow_control>): Print method for flow control policies
print(<parade_job>): Print method for parade job objects
print(<parade_jobset>): Print method for parade_jobset
print(<parade_local_job>): Print method for local jobs
print(<parade_path>): Print method for path object
print(<parade_profile>): Print method for resource profiles
print(<parade_script_job>): Print method for parade script jobs
print(<param_grid>): Print method for parameter grids
profile(): Create a resource profile for SLURM jobs
profile_clear(): Clear all registered profiles
profile_get(): Get a registered resource profile
profile_init_defaults(): Initialize default resource profiles
profile_list(): List all registered resource profiles
profile_register(): Register a named resource profile
profile_remove(): Remove a registered resource profile
progress(): Show progress for jobset completion
register_sink_format(): Register a sink format
register_submit_backend(): Register a submit backend
registry_clean(): Clean up old jobs from registry
registry_ls(): List jobs in registry
res_account(): Alias for account()
res_cpus(): Alias for cpus()
res_mem(): Alias for mem()
res_partition(): Alias for partition()
res_time(): Set time limit for a resource profile (non-masking)
resolve_path(): Resolve paths with URI-style aliases
retry(): Retry failed jobs in a jobset
returns(): Define expected return schema for a stage function
running(): Select running jobs
scaffold_batch_template(): Create a batch job template file
scaffold_flow_job(): Generate scaffold scripts for SLURM flow execution
schema(): Alias for returns function
script_await(): Wait for a SLURM script job to complete
script_cancel(): Cancel a running SLURM script job
script_done(): Check if a SLURM job has completed
script_find_latest(): Find the most recently created script job registries
script_load(): Load a script job from its registry directory
script_logs(): Get log file paths for a SLURM job
script_metrics(): Get CPU and memory metrics for a SLURM job
script_returns(): Declare script output files
script_stage(): Add a script-based stage to a parade flow
script_status(): Get status of a SLURM script job
script_tail(): Display recent log output from a SLURM job
script_top(): Interactive text monitor for a single SLURM job
sink_format(): Define an inline sink format
sink_quick(): Create a sink specification quickly
sink_spec(): Create a sink specification for artifact persistence
sink_temp(): Create a temporary sink specification
slurm_call(): Submit an R function to SLURM
slurm_cluster_plan(): Plan packed chunking for a fixed-size SLURM cluster
slurm_defaults_get(): Get defaults for SLURM (merged from options() and config)
slurm_defaults_set(): Set defaults for SLURM (R session and optionally persist to config)
slurm_map(): Map a function or script over elements via SLURM
slurm_map_cluster(): Map over tasks as if you had one big machine (best-effort)
slurm_pmap(): Parallel map over multiple lists/vectors via SLURM
slurm_resources(): Build SLURM resources with defaults and normalization
slurm_template(): Get path to default SLURM template
slurm_template_default(): Get the default SLURM template path
slurm_template_set(): Set the default SLURM template path
stage(): Add a processing stage to a parade flow
status(): Get status of all jobs in a jobset
stem(): Generate job names from file stems
struct(): Alias for pack function
`[`(<parade_jobset>): Extract subset of jobs
submit(): Submit a flow for deferred execution
submit_slurm(): Submit an R script to SLURM or run locally
tail(<parade_jobset>): Get tail of logs for jobs
tbl(): Create a tibble/data frame type specification
time(): Set time limit for a resource profile
top(): Launch interactive monitor for jobset
use_mirai_local(): Use local mirai daemons
use_mirai_slurm(): Use SLURM-managed mirai daemons
use_mirai_ssh(): Use SSH-tunneled mirai daemons
use_registry(): Get or set active registry
with_parade_options(): Temporarily set parade options for code execution