biomate-ai/biomate-bioconductor-kb/gypsum
Claude Code and agent skill by biomate-ai/biomate-bioconductor-kb
- community
Checking that the SKILL.md file is still in the repository.
Client for the gypsum REST API (https://gypsum.artifactdb.com), a cloud-based file store in the ArtifactDB ecosystem. This package provides functions for uploads, downloads, and various adminstrative and management tasks. Check out the docu
Install
npx vskill@latest install biomate-ai/biomate-bioconductor-kb/gypsumSKILL.md
The same SKILL.md was published earlier as biomate-ai/biomate-bioconductor-kb/gypsum.
gypsum
Dependencies & Environment
Package-intrinsic requirements from the Bioconductor landing page — reproduce in any R environment.
- Version: 1.8.0 · Bioconductor: 3.23 · R: ≥ 4.6
- Depends: httr2, jsonlite, filelock, rappdirs
- Imports: httr2, jsonlite, filelock, rappdirs
- Install:
BiocManager::install("gypsum")
When to Use
- Programmatically downloading files, manifests, and summaries from the gypsum bucket using
saveFile,saveVersion,fetchManifest, andfetchSummary. - Uploading files to the gypsum backend using the upload sequence:
startUpload,uploadFiles, andcompleteUpload. - Creating new versions of existing assets efficiently by deduplicating redundant files using
cloneVersionandprepareDirectoryUpload. - Validating metadata against the Bioconductor JSON schema prior to upload using
validateMetadata. - Managing project permissions, probational uploads, and quotas using
setPermissions,approveProbation, andsetQuota.
When NOT to Use
- For general-purpose cloud storage interactions (like raw Google Cloud Storage buckets) without an ArtifactDB backend, use packages like
googleCloudStorageRinstead. - For downloading standard Bioconductor package source files or annotation resources, use
BiocManagerorAnnotationHubinstead. - For local-only file management and caching without a REST API backend, use
BiocFileCacheinstead.
Data Requirements
- Input format: File paths, directory structures, or metadata lists formatted according to the ArtifactDB JSON schema.
- Authentication: Requires a GitHub OAuth token for write operations (uploads, deletions, permission changes), set via
setAccessToken. Read operations are public. - Network: Requires an active internet connection to communicate with the gypsum REST API endpoint.
Key Parameters
- project: Character; the name of the project on the gypsum server.
- asset: Character; the specific asset within the project.
- version: Character; the version string of the asset to upload or download.
- directory: Character; local directory path containing files for upload in
startUploadanduploadFiles. - destination: Character; local directory path where downloaded files should be saved in
cloneVersion. - links: Data frame; used in
startUploadto deduplicate redundant files on the backend by linking to existing files.
Best Practices
- Wrap the upload sequence (
uploadFiles,completeUpload) in atryCatchblock and callabortUploadin the error handler to clean up if the upload fails. - Use
cloneVersionandprepareDirectoryUploadto expedite the creation of new asset versions by linking unmodified files to their counterparts in the previous version. - Always validate metadata using
validateMetadataagainst the schema fetched byfetchMetadataSchemato ensure downstream databases can index the files. - Check the current usage of a project using
fetchUsageandfetchQuotabefore initiating large uploads to ensure sufficient storage space.
Common Pitfalls
- Unauthorized upload attempts: Attempting to upload or modify assets without setting a valid GitHub token will fail; fix this by authenticating using
setAccessTokenor prompting the user. - Modifying symlinks directly: When using
cloneVersion, modifying a symlinked file directly will alter the linked source; fix this by deleting the symlink and replacing it with a new file before uploading. - Incomplete uploads: Failing to call
completeUploadafteruploadFilesleaves the upload in a pending state; ensure the full upload sequence is executed.
Alternatives
- BiocFileCache: Best for managing local caches of remote files without a dedicated REST API backend.
- AnnotationHub / ExperimentHub: The standard Bioconductor infrastructure for distributing curated annotation and experimental datasets.
Citations
- Lun et al. (2024), "Interface to the gypsum REST API", Bioconductor Manual.
References
- Homepage: https://bioconductor.org/packages/gypsum
- Vignette: https://bioconductor.org/packages/release/bioc/vignettes/gypsum/inst/doc/userguide.html
<!-- biomate-cta -->
Run this on BioMate
This skill is the knowledge layer — when, why, and how to use gypsum. To run this analysis on your own data with managed compute, automated QC, and reproducible outputs, use [BioMate](https://www.biomate.ai?ref=kb&pkg=gypsum) — free to start.
▶ [Open `gypsum` on BioMate →](https://www.biomate.ai?ref=kb&pkg=gypsum)
Security
- Security scanPassed, 100 of 100Pattern checks on the skill's files.
- Model reviewNot runA model review is scheduled for the next rescan.
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingskills/general/gypsum/SKILL.md
Popularity
- Repository stars
- 805
- Repository forks
- 67
- 7-day trend score
- 33
Stars and forks are for the whole GitHub repository, not this skill alone. Not refreshed yet.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/biomate-ai/biomate-bioconductor-kb/gypsum)