ARC Creator
Create FAIR Digital Objects following the nfdi4plants ARC specification v3.0.0.
Prerequisites
git and git-lfs installed
- ARC Commander CLI at
~/bin/arc (optional but recommended)
- For DataHUB sync: Personal Access Token for git.nfdi4plants.org or datahub.hhu.de
Interactive ARC Creation Workflow
Guide the user through these phases in order. Ask questions conversationally — don't dump all questions at once. Batch 2-4 related questions per message.
Phase 1: Investigation Setup
Ask the user:
- Investigation identifier (short, lowercase-hyphenated, e.g.
cold-stress-arabidopsis)
- Title (concise name for the investigation)
- Description (textual description of the research goals)
- Where to store the ARC locally (suggest
[REDACTED_ABSOLUTE_PATH]<identifier>/)
Then run scripts/create_arc.sh <path> <identifier> and set investigation metadata via:
arc investigation update -i "<id>" --title "<title>" --description "<desc>"
Phase 2: Studies
For each study, ask:
- Study identifier (e.g.
plant-growth)
- Title and description
- Organism (for Characteristic [Organism])
- Growth conditions (temperature, light, medium, etc.)
- Source materials (what goes in — seeds, cell lines, etc.)
- Sample materials (what comes out — leaves, roots, extracts, etc.)
- Protocols — does the user have protocol documents to include?
- Factors — what experimental variables are being tested? (e.g., temperature, genotype, treatment)
Create with:
arc study init --studyidentifier "<id>"
arc study update --studyidentifier "<id>" --title "<title>" --description "<desc>"
Copy protocol files to studies/<id>/protocols/.
Copy resource files to studies/<id>/resources/.
Phase 3: Assays
For each assay, ask:
- Assay identifier (e.g.
proteomics-ms, rnaseq, sugar-measurement)
- Measurement type (e.g., protein expression profiling, transcription profiling, metabolite profiling)
- Technology type (e.g., mass spectrometry, nucleotide sequencing, plate reader)
- Technology platform (e.g., Illumina NovaSeq, Bruker timsTOF)
- Data files — where are the raw data files? (will go into
assays/<id>/dataset/)
- Processed data — any processed output files?
- Protocols — assay-specific protocols?
- Performers — who performed this assay? (name, affiliation, role)
Create with:
arc assay init -a "<id>" --measurementtype "<type>" --technologytype "<tech>"
Copy data to assays/<id>/dataset/, protocols to assays/<id>/protocols/.
Phase 4: Workflows (optional)
Ask if there are computational analysis steps. For each:
- Workflow identifier (e.g.
deseq2-analysis, heatmap-generation)
- Description of what it does
- Code files (scripts, notebooks)
- Dependencies (Python packages, R libraries, Docker image)
Place code in workflows/<id>/.
Note: workflow.cwl is REQUIRED by spec but often created later. Inform user.
Phase 5: Runs (optional)
Ask if there are computation outputs. For each:
- Run identifier
- Which workflow produced it
- Output files (figures, tables, processed data)
Place outputs in runs/<id>/.
Phase 6: Contacts & Publications
Ask:
- Investigation contacts (name, email, affiliation, role — at minimum the PI)
- Publications (if any — DOI, PubMed ID, title, authors)
Add via:
arc investigation person register --lastname "<last>" --firstname "<first>" --email "<email>" --affiliation "<aff>"
Phase 7: Git Commit & DataHUB Sync
- Configure git user:
git config user.name "<name>"
git config user.email "<email>"
- Commit:
git add -A
git commit -m "Initial ARC: <investigation title>"
- Ask if the user wants to push to a DataHUB. If yes:
- Ask which host (git.nfdi4plants.org, datahub.hhu.de, etc.)
- Create remote repo (via browser or API)
- Set remote and push
ISA Metadata Reference
For detailed ISA-XLSX fields, annotation table columns, and ontology references, read references/arc-spec.md.
Key Reminders
- Assay data is immutable — never modify files in
assays/<id>/dataset/ after initial placement
- Studies describe materials, assays describe measurements
- Workflows are code, runs are outputs
- Git LFS for files > 100 MB:
git lfs track "*.fastq.gz" "*.bam" "*.raw"
- Don't store ARCs on OneDrive/Dropbox — Git + cloud sync causes conflicts
- ARC Commander CLI reference:
arc <subcommand> --help
1---2name: arc-creator-23description: Create and populate Annotated Research Contexts (ARCs) following the nfdi4plants ARC specification. Use when creating a new ARC, adding studies/assays/workflows/runs, annotating ISA metadata, organizing research data into ARC structure, or pushing ARCs to a DataHUB. Guides the user interactively through all required and optional metadata fields.4metadata:5 source: https://skillmd.com/skills/bishal-pdmsft/arc-creator-26---78# ARC Creator910Create FAIR Digital Objects following the nfdi4plants ARC specification v3.0.0.1112## Prerequisites1314- `git` and `git-lfs` installed15- ARC Commander CLI at `~/bin/arc` (optional but recommended)16- For DataHUB sync: Personal Access Token for git.nfdi4plants.org or datahub.hhu.de1718## Interactive ARC Creation Workflow1920Guide the user through these phases in order. Ask questions conversationally — don't dump all questions at once. Batch 2-4 related questions per message.2122### Phase 1: Investigation Setup2324Ask the user:251. **Investigation identifier** (short, lowercase-hyphenated, e.g. `cold-stress-arabidopsis`)262. **Title** (concise name for the investigation)273. **Description** (textual description of the research goals)284. **Where to store the ARC locally** (suggest `[REDACTED_ABSOLUTE_PATH]<identifier>/`)2930Then run `scripts/create_arc.sh <path> <identifier>` and set investigation metadata via:31```bash32arc investigation update -i "<id>" --title "<title>" --description "<desc>"33```3435### Phase 2: Studies3637For each study, ask:381. **Study identifier** (e.g. `plant-growth`)392. **Title and description**403. **Organism** (for Characteristic [Organism])414. **Growth conditions** (temperature, light, medium, etc.)425. **Source materials** (what goes in — seeds, cell lines, etc.)436. **Sample materials** (what comes out — leaves, roots, extracts, etc.)447. **Protocols** — does the user have protocol documents to include?458. **Factors** — what experimental variables are being tested? (e.g., temperature, genotype, treatment)4647Create with:48```bash49arc study init --studyidentifier "<id>"50arc study update --studyidentifier "<id>" --title "<title>" --description "<desc>"51```5253Copy protocol files to `studies/<id>/protocols/`.54Copy resource files to `studies/<id>/resources/`.5556### Phase 3: Assays5758For each assay, ask:591. **Assay identifier** (e.g. `proteomics-ms`, `rnaseq`, `sugar-measurement`)602. **Measurement type** (e.g., protein expression profiling, transcription profiling, metabolite profiling)613. **Technology type** (e.g., mass spectrometry, nucleotide sequencing, plate reader)624. **Technology platform** (e.g., Illumina NovaSeq, Bruker timsTOF)635. **Data files** — where are the raw data files? (will go into `assays/<id>/dataset/`)646. **Processed data** — any processed output files?657. **Protocols** — assay-specific protocols?668. **Performers** — who performed this assay? (name, affiliation, role)6768Create with:69```bash70arc assay init -a "<id>" --measurementtype "<type>" --technologytype "<tech>"71```7273Copy data to `assays/<id>/dataset/`, protocols to `assays/<id>/protocols/`.7475### Phase 4: Workflows (optional)7677Ask if there are computational analysis steps. For each:781. **Workflow identifier** (e.g. `deseq2-analysis`, `heatmap-generation`)792. **Description** of what it does803. **Code files** (scripts, notebooks)814. **Dependencies** (Python packages, R libraries, Docker image)8283Place code in `workflows/<id>/`.84Note: `workflow.cwl` is REQUIRED by spec but often created later. Inform user.8586### Phase 5: Runs (optional)8788Ask if there are computation outputs. For each:891. **Run identifier**902. **Which workflow produced it**913. **Output files** (figures, tables, processed data)9293Place outputs in `runs/<id>/`.9495### Phase 6: Contacts & Publications9697Ask:981. **Investigation contacts** (name, email, affiliation, role — at minimum the PI)992. **Publications** (if any — DOI, PubMed ID, title, authors)100101Add via:102```bash103arc investigation person register --lastname "<last>" --firstname "<first>" --email "<email>" --affiliation "<aff>"104```105106### Phase 7: Git Commit & DataHUB Sync1071081. Configure git user:109```bash110git config user.name "<name>"111git config user.email "<email>"112```1131142. Commit:115```bash116git add -A117git commit -m "Initial ARC: <investigation title>"118```1191203. Ask if the user wants to push to a DataHUB. If yes:121 - Ask which host (git.nfdi4plants.org, datahub.hhu.de, etc.)122 - Create remote repo (via browser or API)123 - Set remote and push124125## ISA Metadata Reference126127For detailed ISA-XLSX fields, annotation table columns, and ontology references, read `references/arc-spec.md`.128129## Key Reminders130131- **Assay data is immutable** — never modify files in `assays/<id>/dataset/` after initial placement132- **Studies describe materials**, assays describe measurements133- **Workflows are code**, runs are outputs134- **Git LFS** for files > 100 MB: `git lfs track "*.fastq.gz" "*.bam" "*.raw"`135- **Don't store ARCs on OneDrive/Dropbox** — Git + cloud sync causes conflicts136- ARC Commander CLI reference: `arc <subcommand> --help`