Skip to contents

Version 0.14

artutils 0.14.0

pkgdown Documentation Infrastructure

This release introduces comprehensive pkgdown documentation with automatic GitHub Pages deployment, lifecycle tagging for unused functions, and improved function organization.

NEW FEATURES

  • pkgdown Documentation Site
    • Added _pkgdown.yml configuration with function groupings via has_concept() selectors
    • Site auto-deploys to https://docs.artalytics.dev/r/artutils on push to main
    • Added .github/workflows/pkgdown.yaml GitHub Actions workflow
    • Reference page organized into 6 logical groups: Data Access, Data Modifiers, Path Utilities, Application Data, Database Interface, Under Review
  • Vignettes
    • vignettes/artutils.Rmd - Get Started guide with package overview, environment setup, quick start
    • vignettes/data-access-patterns.Rmd - End-to-end query workflows (artist discovery, gallery views, frame analysis)
    • vignettes/data-modification-workflows.Rmd - WRITE operations (addArtist, addCollection, updateArtistStats)
  • Artist Profile Data Functions (PR #66)
  • Artist Settings & Visibility Functions (PR #63)
    • filter_visible_collections() - Privacy-aware collection filtering
    • Settings functions for artist preferences and collection visibility
  • Featured Artist Support (PR #68)

LIFECYCLE CHANGES

  • 37 Functions Moved to R/considering.R (lifecycle: questioning)
    • Functions with no external callers in the platform codebase
    • Tagged with lifecycle::deprecate_soft() - warns once per session
    • Functions remain exported to avoid breaking unknown callers
    • If you depend on any of these functions, please file an issue
    Affected functions include:
    • Benchmark calculations: calcArtworkBenchmarks(), calcArtworkBenchmarks_p()
    • Artist data: getArtistStats(), getArtistName(), getArtistBenchmarks(), getCollectionSummary(), list_artists(), list_collections(), getArtistSummary(), listArtworkUUIDs(), getArtworksTable(), getAllArtistData(), updateArtist()
    • Artwork data: getArtworkPaths(), getArtworkColors(), getArtworkStyles(), getArtworkHash(), getArtworkCOA()
    • Collections: getCollections(), deleteCollection()
    • Asset paths: pathArtVaultImage(), pathCanvasSign(), pathLottieJSON(), pathPackageCSS()
    • Counts: getCountFrames(), getCountVariants(), getCountCarousel()
    • Settings: get_artist_preferences(), upsert_artist_preferences(), get_collection_settings(), update_collection_settings(), is_collection_visible()
    • Other: update_has_nft()

IMPROVEMENTS

  • Documentation Quality
    • All exported functions now have @family tags for pkgdown grouping
    • @family tags generate both concept tags (for pkgdown) and “See Also” cross-references
    • Fixed @seealso reference to unavailable artpipelines package
    • Improved @param documentation for database interface functions
  • Performance
    • get_artist_stats() optimized with separate COUNT queries (PR #66)
    • Collections now ordered by most recent artwork upload

BUG FIXES

  • Fixed artist_uuid missing from get_artist_collections_summary() output (#68)
  • Fixed class attribute mismatch in rbindlist for settings functions
  • Fixed NA handling in preference joins
  • Renamed blend_rate_normalized component to ave_blend_rate for consistency

BREAKING CHANGES

  • UI Components Migrated to artshiny (PR #60)
    • mod_statsBox() and related UI functions removed
    • Use artshiny package for Shiny UI components

INTERNAL

  • Removed artwork_settings table references (deprecated)
  • Moved calc_percentile() to artcore package
  • Removed complex mock tests dependent on artshiny
  • Cleaned up delete functionality (moved to internal dev package)

DEPENDENCIES

  • Added lifecycle to Imports (for deprecation warnings)
  • Added knitr, rmarkdown to Suggests (for vignettes)
  • Added VignetteBuilder: knitr to DESCRIPTION