Package: gypsum 1.3.0

Aaron Lun

gypsum: Interface to the gypsum REST API

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 documentation at https://github.com/ArtifactDB/gypsum-worker for more details.

Authors:Aaron Lun [aut, cre]

gypsum_1.3.0.tar.gz
gypsum_1.3.0.zip(r-4.5)gypsum_1.3.0.zip(r-4.4)gypsum_1.3.0.zip(r-4.3)
gypsum_1.3.0.tgz(r-4.4-any)gypsum_1.3.0.tgz(r-4.3-any)
gypsum_1.3.0.tar.gz(r-4.5-noble)gypsum_1.3.0.tar.gz(r-4.4-noble)
gypsum_1.3.0.tgz(r-4.4-emscripten)gypsum_1.3.0.tgz(r-4.3-emscripten)
gypsum.pdf |gypsum.html✨
gypsum/json (API)
NEWS

# Install 'gypsum' in R:
install.packages('gypsum', repos = c('https://bioc.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/artifactdb/gypsum-r/issues

On BioConductor:gypsum-1.1.6(bioc 3.20)gypsum-1.0.1(bioc 3.19)

dataimport

6.32 score 1 packages 20 scripts 3.5k downloads 47 exports 16 dependencies

Last updated 24 days agofrom:c2d990ceda. Checks:OK: 3 NOTE: 4. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 30 2024
R-4.5-winNOTEOct 30 2024
R-4.5-linuxNOTEOct 30 2024
R-4.4-winNOTEOct 30 2024
R-4.4-macNOTEOct 30 2024
R-4.3-winOKOct 30 2024
R-4.3-macOKOct 30 2024

Exports:abortUploadaccessTokenapproveProbationcacheDirectorycloneVersioncompleteUploadcreateProjectdefineTextQueryfetchLatestfetchManifestfetchMetadataDatabasefetchMetadataSchemafetchPermissionsfetchQuotafetchSummaryfetchUsageformatObjectMetadatagsclistAssetslistFileslistProjectslistVersionsprepareDirectoryUploadpublicS3ConfigrefreshLatestrefreshUsagerejectProbationremoveAssetremoveProjectremoveVersionresolveLinksrestUrlsaveFilesaveVersionsearchMetadatasearchMetadataFiltersearchMetadataTextsearchMetadataTextFiltersetAccessTokensetPermissionssetQuotastartUploadtranslateTextQueryunlockProjectuploadDirectoryuploadFilesvalidateMetadata

Dependencies:askpassclicurlfilelockgluehttr2jsonlitelifecyclemagrittropensslR6rappdirsrlangsysvctrswithr

Interacting with the gypsum REST API

Aaron Lun

Rendered fromuserguide.Rmdusingknitr::rmarkdownon Oct 30 2024.

Last update: 2024-04-03
Started: 2023-12-06

Readme and manuals

Help Manual

Help pageTopics
Abort an uploadabortUpload
Get and set GitHub access tokensaccessToken setAccessToken
Approve a probational uploadapproveProbation
Cache directorycacheDirectory
Clone a version's directory structurecloneVersion
Complete an uploadcompleteUpload
Create a new projectcreateProject
Fetch the latest versionfetchLatest
Fetch version manifestfetchManifest
Fetch a metadata databasefetchMetadataDatabase
Fetch a metadata schemafetchMetadataSchema
Fetch project permissionsfetchPermissions
Fetch project quota detailsfetchQuota
Fetch version summaryfetchSummary
Fetch project usage detailsfetchUsage
Format object-related metadataformatObjectMetadata
List assetslistAssets
List files for a versionlistFiles
List all projectslistProjects
List asset versionslistVersions
Prepare to upload a directoryprepareDirectoryUpload
Public S3 configurationpublicS3Config
Refresh the latest versionrefreshLatest
Refresh the quota usagerefreshUsage
Reject a probational uploadrejectProbation
Remove an assetremoveAsset
Remove a projectremoveProject
Remove a version of an assetremoveVersion
Resolve links in the cache directoryresolveLinks
URL for the REST APIrestUrl
Save a file from a version of a project assetsaveFile
Save all files for a version of a project assetsaveVersion
Search the metadata databasedefineTextQuery gsc gypsum.search.clause Ops.gypsum.search.clause searchMetadata searchMetadataFilter searchMetadataText searchMetadataTextFilter
Set project permissionssetPermissions
Set project quotasetQuota
Start an uploadstartUpload
Translate a plain-text query to a gypsum.search.clausetranslateTextQuery
Unlock a projectunlockProject
Upload a directory to the gypsum backenduploadDirectory
Upload files for a versioned assetuploadFiles
Validate metadata against a JSON schemavalidateMetadata