{"id":30805310,"url":"https://github.com/bbuchsbaum/parade","last_synced_at":"2025-09-06T00:55:23.716Z","repository":{"id":311694929,"uuid":"1044617121","full_name":"bbuchsbaum/parade","owner":"bbuchsbaum","description":null,"archived":false,"fork":false,"pushed_at":"2025-08-26T03:15:42.000Z","size":1351,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-26T03:25:07.723Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://bbuchsbaum.github.io/parade/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bbuchsbaum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-26T00:53:24.000Z","updated_at":"2025-08-26T03:12:16.000Z","dependencies_parsed_at":"2025-08-26T03:25:24.898Z","dependency_job_id":"d6afad65-8458-446f-8138-224e41703efe","html_url":"https://github.com/bbuchsbaum/parade","commit_stats":null,"previous_names":["bbuchsbaum/parade"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/bbuchsbaum/parade","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbuchsbaum%2Fparade","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbuchsbaum%2Fparade/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbuchsbaum%2Fparade/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbuchsbaum%2Fparade/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bbuchsbaum","download_url":"https://codeload.github.com/bbuchsbaum/parade/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbuchsbaum%2Fparade/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273842848,"owners_count":25177921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-06T00:55:22.049Z","updated_at":"2025-09-06T00:55:23.694Z","avatar_url":"https://github.com/bbuchsbaum.png","language":"R","readme":"# parade\n\n[![R-CMD-check](https://github.com/bbuchsbaum/parade/actions/workflows/check.yaml/badge.svg)](https://github.com/bbuchsbaum/parade/actions/workflows/check.yaml) [![codecov](https://codecov.io/gh/bbuchsbaum/parade/branch/main/graph/badge.svg)](https://codecov.io/gh/bbuchsbaum/parade)\n\n**Declarative parallel dataflow for R** — from laptop to HPC.\nDefine *what* to compute, not *how* to loop. Parade builds typed, parallel workflows; persists large outputs as **artifacts** (sinks); and talks to **SLURM** directly (submit, monitor, cancel) so you rarely have to leave R.\n\n- Website \u0026 docs: https://bbuchsbaum.github.io/parade/\n- Source: https://github.com/bbuchsbaum/parade\n\n\u003e **Why parade?** Clean, composable pipelines with explicit types and lazily persisted outputs, plus first-class HPC ergonomics (portable paths, SLURM defaults, live monitoring).\n\n## Install\n\n```r\n# development version\n# install.packages(\"remotes\")\nremotes::install_github(\"bbuchsbaum/parade\")\n```\n\nNote: The CRAN package named `parade` is unrelated (economic \"income parades\"). This project is currently GitHub-only.\n\n## 60-second tour\n\n```r\nlibrary(parade)\nlibrary(progressr)\nhandlers(global = TRUE)   # progress bars everywhere\n\npaths_init()              # portable paths: artifacts://, data://, etc.\n\n# Declare the parameter space\ngrid \u003c- param_grid(subject = c(\"s01\", \"s02\"), session = 1:2)\n\n# Build a typed, composable pipeline\nfl \u003c- flow(grid) |\u003e\n  stage(\n    id = \"fit\",\n    f = function(subject, session) {\n      model \u003c- lm(rnorm(1000) ~ rnorm(1000))\n      list(model = model, rmse = runif(1))\n    },\n    schema = schema(model = artifact(), rmse = dbl()),   # big → artifact, small → memory\n    sink   = sink_spec(fields = \"model\",\n                       dir = \"artifacts://fits\",\n                       template = \"{.stage}/{subject}/ses{session}-{.row_key}\")\n  )\n\n# Execute locally or with futures/mirai/SLURM\nres \u003c- collect(fl, engine = \"future\", workers = 4)\n\nres$model[[1]]   # file-ref (path, bytes, sha256, written/existed)\nres$rmse         # numeric in-memory\n```\n\n- **Artifacts (sinks)** keep memory tiny and runs resumable — see the [Artifacts vignette](https://bbuchsbaum.github.io/parade/articles/parade-artifacts.html).\n- **Portable paths** like `artifacts://` resolve to scratch on HPC or temp on laptops — see [Smart Path Management](https://bbuchsbaum.github.io/parade/articles/parade-paths.html).\n- **Typed returns** (`dbl()`, `int()`, `lst()`, `artifact()`) catch mistakes early — see [Core concepts](https://bbuchsbaum.github.io/parade/articles/parade-core.html).\n\n## Submit \u0026 monitor SLURM jobs from R\n\n```r\npaths_init()\n\nslurm_defaults_set(\n  partition = \"general\",\n  time = \"2h\",           # accepts 2h / 120min / H:MM:SS\n  cpus_per_task = 8,\n  mem = NA,              # omit --mem if your site forbids it\n  persist = TRUE\n)\n\njob \u003c- submit_slurm(\"scripts/train.R\", args = c(\"--fold\", \"1\"))\n\nscript_status(job)  # quick check\nscript_tail(job, 80)\nscript_top(job)     # live CPU/RSS and logs\n\n# Multiple jobs together:\njobs_top(list(job1, job2, job3))\n```\n\n- **Defaults \u0026 omit-by-NA** are built in — see [Using SLURM Defaults](https://bbuchsbaum.github.io/parade/articles/parade-defaults.html).\n- **`script_top()` / `jobs_top()`** give a text dashboard for CPU/RSS + logs — see [SLURM script submission \u0026 monitoring](https://bbuchsbaum.github.io/parade/articles/parade-scripts-monitoring.html).\n- **Distribution options** (grouping/barriers, throttling, chunking) are declarative — see [Distribution: local \u0026 SLURM](https://bbuchsbaum.github.io/parade/articles/parade-slurm-distribution.html).\n\n## Mirai backend (optional)\n\nUse mirai for low-latency, scalable fan-out (no socket limits; SSH/TLS if needed).\n\n```r\n# dev: local daemons\nfl |\u003e\n  distribute(dist_mirai(n = 8, dispatcher = TRUE)) |\u003e\n  collect()\n\n# HPC: daemon pools under SLURM\nhandle \u003c- fl |\u003e\n  distribute(use_mirai_slurm(n = 32, partition = \"compute\", time = \"2h\")) |\u003e\n  submit()\n```\n\nSee [Mirai backend](https://bbuchsbaum.github.io/parade/articles/parade-mirai.html) for patterns and tradeoffs.\n\n## Portable paths (laptop ↔ HPC without edits)\n\nWrite once, run anywhere:\n- `artifacts://` → `/scratch/$USER/parade-artifacts` on SLURM, tempdir on laptops\n- `data://`, `project://`, `scratch://`, `registry://`, `config://`, `cache://`\n\nConfigure via `paths_set()` or env vars (`PARADE_ARTIFACTS`, `PARADE_SCRATCH`, …). See [Smart Path Management](https://bbuchsbaum.github.io/parade/articles/parade-paths.html).\n\n## Why not {targets} / {drake} / {furrr}?\n\nParade is deliberately small and compositional:\n- Dataframe-shaped param grids vs. global DAG caches\n- Pseudo-typed returns for crisp contracts\n- Built-in sinks for large results\n- HPC ergonomics: SLURM submission, defaults, monitoring, path aliases\n\nThey play nicely together; parade focuses on elegant, fast fan-out/fan-in.\n\n## Learn more\n\n- Parade core: flows, stages, schemas → https://bbuchsbaum.github.io/parade/articles/parade-core.html\n- Artifacts \u0026 sinks → https://bbuchsbaum.github.io/parade/articles/parade-artifacts.html\n- Distribution (local/SLURM) → https://bbuchsbaum.github.io/parade/articles/parade-slurm-distribution.html\n- SLURM monitoring → https://bbuchsbaum.github.io/parade/articles/parade-scripts-monitoring.html\n- Mirai backend → https://bbuchsbaum.github.io/parade/articles/parade-mirai.html\n- Paths → https://bbuchsbaum.github.io/parade/articles/parade-paths.html\n\n## Contributing\n\nPRs welcome! Please:\n- follow tidyverse style (lintr + styler),\n- add tests for new user-facing behavior,\n- update roxygen and a NEWS entry.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbuchsbaum%2Fparade","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbbuchsbaum%2Fparade","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbuchsbaum%2Fparade/lists"}