本文へ移動
cccskills
無料GitHub で公開

bioconductor-gypsum

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

インストール方法を見る

含まれるファイル(1)

  • SKILL.md5.5 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

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, and fetchSummary.
  • Uploading files to the gypsum backend using the upload sequence: startUpload, uploadFiles, and completeUpload.
  • Creating new versions of existing assets efficiently by deduplicating redundant files using cloneVersion and prepareDirectoryUpload.
  • Validating metadata against the Bioconductor JSON schema prior to upload using validateMetadata.
  • Managing project permissions, probational uploads, and quotas using setPermissions, approveProbation, and setQuota.

When NOT to Use

  • For general-purpose cloud storage interactions (like raw Google Cloud Storage buckets) without an ArtifactDB backend, use packages like googleCloudStorageR instead.
  • For downloading standard Bioconductor package source files or annotation resources, use BiocManager or AnnotationHub instead.
  • For local-only file management and caching without a REST API backend, use BiocFileCache instead.

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 startUpload and uploadFiles.
  • destination: Character; local directory path where downloaded files should be saved in cloneVersion.
  • links: Data frame; used in startUpload to deduplicate redundant files on the backend by linking to existing files.

Best Practices

  • Wrap the upload sequence (uploadFiles, completeUpload) in a tryCatch block and call abortUpload in the error handler to clean up if the upload fails.
  • Use cloneVersion and prepareDirectoryUpload to expedite the creation of new asset versions by linking unmodified files to their counterparts in the previous version.
  • Always validate metadata using validateMetadata against the schema fetched by fetchMetadataSchema to ensure downstream databases can index the files.
  • Check the current usage of a project using fetchUsage and fetchQuota before 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 setAccessToken or 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 completeUpload after uploadFiles leaves 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

<!-- 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 — free to start.

▶ Open gypsum on BioMate →

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

The package contains functions for exploratory oligonucleotide array analysis. The dependence on tkWidgets only concerns few convenience functions. 'affy' is fully functional without it.

日本語の概要は準備中です。原文の説明を表示しています。

bioMate-AI/biomate-bioconductor-kb8042026年6月21日 更新

This tool uses the label-tree function from HyPhy to annotate a phylogenetic tree. It allows users to select a subset of leaves using either a regular expression or a list of sequence names, and then apply a specified label to these selecte

日本語の概要は準備中です。原文の説明を表示しています。

bioMate-AI/biomate-bioconductor-kb8042026年6月21日 更新

This package provides a client for the Bioconductor AnnotationHub web resource. The AnnotationHub web resource provides a central location where genomic files (e.g., VCF, bed, wig) and other resources from standard locations (e.g., UCSC, En

日本語の概要は準備中です。原文の説明を表示しています。

bioMate-AI/biomate-bioconductor-kb8042026年6月21日 更新

apeglm provides Bayesian shrinkage estimators for effect sizes for a variety of GLM models, using approximation of the posterior for individual coefficients.

日本語の概要は準備中です。原文の説明を表示しています。

bioMate-AI/biomate-bioconductor-kb8042026年6月21日 更新

ASURAT is a software for single-cell data analysis. Using ASURAT, one can simultaneously perform unsupervised clustering and biological interpretation in terms of cell type, disease, biological process, and signaling pathway activity. Inputting a single-cell RNA-seq data and knowledge-based databases, such as Cell Ontology, Gene Ontology, KEGG, etc., ASURAT transforms gene expression tables into original multivariate tables, termed sign-by-sample matrices (SSMs).

日本語の概要は準備中です。原文の説明を表示しています。

bioMate-AI/biomate-bioconductor-kb8042026年6月21日 更新

AUCell allows to identify cells with active gene sets (e.g. signatures, gene modules...) in single-cell RNA-seq data. AUCell uses the "Area Under the Curve" (AUC) to calculate whether a critical subset of the input gene set is enriched with

日本語の概要は準備中です。原文の説明を表示しています。

bioMate-AI/biomate-bioconductor-kb8042026年6月21日 更新

bioMate-AI のスキルをすべて見る

このスキルの問題を報告する