Skip to content

CLAUDE.md

Latest commit

 

History

History
82 lines (58 loc) · 2.66 KB

CLAUDE.md

File metadata and controls

82 lines (58 loc) · 2.66 KB
Raw

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Development Commands

# Load package for interactive development
devtools::load_all()

# Run all tests
devtools::test()

# Run a single test file
testthat::test(filter = "board_folder")

# Generate documentation from roxygen comments
devtools::document()

# Run R CMD check (CI runs with error-on: "note")
devtools::check()

Package Overview

pins is an R package for publishing data, models, and other R objects to various storage backends called "boards". Pins can be versioned and include metadata. There is also a companion pins for Python package with cross-language compatibility.

Architecture

Board System

The core abstraction is the board - a storage location for pins. All boards inherit from pins_board and implement S3 methods:

  • pin_store() - save a pin to the board
  • pin_fetch() - retrieve a pin from the board
  • pin_meta() - get pin metadata
  • pin_list() - list all pins on a board
  • pin_exists() - check if a pin exists
  • pin_delete() - remove a pin
  • pin_versions() - list versions of a pin
  • pin_version_delete() - delete a specific version

Board implementations in R/board_*.R:

  • board_folder() / board_temp() / board_local() - local filesystem
  • board_connect() - Posit Connect
  • board_s3() - AWS S3 (and S3-compatible storage)
  • board_gcs() - Google Cloud Storage
  • board_azure() - Azure Blob Storage
  • board_url() - read-only board from URLs
  • board_databricks() - Databricks Volumes
  • board_ms365() - Microsoft 365 (OneDrive/SharePoint)
  • board_gdrive() - Google Drive

API Versions

The package has two API versions:

  • v1 (modern): Uses pin_read()/pin_write() - preferred
  • v0 (legacy): Uses pin_get()/pin() - deprecated, files in R/legacy_*.R

New board implementations should use new_board_v1().

Pin Types

Supported serialization types: rds, json, csv, parquet, arrow, qs2

Testing

Test helpers in R/testthat.R provide standard test suites for board implementations:

  • test_api_basic() - core pin operations
  • test_api_versioning() - version management
  • test_api_meta() - metadata handling
  • test_api_manifest() - board manifest files

Board test files call these helpers, e.g., test_api_basic(board_temp()).

Key Files

  • R/pin-read-write.R - main user-facing functions
  • R/board.R - board base class and utilities
  • R/testthat.R - shared test infrastructure and error constructors
  • R/meta.R and R/pin-meta.R - metadata handling
  • R/versions.R and R/pin_versions.R - version management