Skip to contents

artaverse

R Package Version
R Package Version

Overview

artaverse is the meta-package for the Artalytics platform. It provides a convenient way to install and attach all core Artalytics packages in a single step, similar to how tidyverse works for its ecosystem.

Installation

Install the full Artalytics platform with:

# Using pak (recommended)
pak::pkg_install("artalytics/artaverse")

# Or using remotes
remotes::install_github("artalytics/artaverse")

This single command will install: - All core Artalytics packages (foundation, UI, modules, main app) - Their dependencies

Usage

Interactive Sessions

Load core packages for interactive use:

library(artaverse)
#> ── Attaching Artalytics Platform artaverse 0.0.1 ──
#> ✔ artcore    0.1.0     ✔ appPlatform 0.1.0
#> ✔ artutils   0.1.0     ✔ modArtist   0.1.0
#> ✔ artshiny   0.1.0     ✔ modBrowse   0.1.0
#> ✔ artauth    0.1.0     ✔ modGallery  0.1.0
#> ...

Discover Packages 

# See all packages by category
artaverse_packages()

# List just core packages
artaverse_core()

# List extended/optional packages
artaverse_extended()

# Check installed versions
artaverse_versions()

Package Categories

Core Packages

Essential packages automatically installed and attached with artaverse:

  • Foundation (platform/core/): artcore, artutils, artauth
  • Application (platform/app/): artshiny, appPlatform
  • Modules (platform/app/): modArtist, modBrowse, modGallery, modUpload, modFrames

Extended Packages

Optional packages for specialized functionality:

  • Development (platform/misc/): arthelpers
  • Pipelines (platform/tool/): artpipelines, artbenchmark, artcurator, artpixeltrace
  • Integrations (platform/api/): artopenai, artgemini, artopensea, artsend

Extended packages can be installed individually as needed:

pak::pkg_install("artalytics/artopenai")

Important: Not a Dependency

⚠️ artaverse should NOT be used as a dependency in other Artalytics packages.

Other packages should depend on the specific components they require (e.g., artcore, artutils, modBrowse) rather than on artaverse.

artaverse is intended for:

  • ✅ Interactive R sessions
  • ✅ Notebooks and example scripts
  • ✅ Environment bootstrapping
  • ✅ Demo applications
  • ✅ Docker-based development environments

artaverse is NOT intended for:

  • ❌ Being listed in DESCRIPTION dependencies of other packages
  • ❌ Production package dependencies

For Developers

Updating Package Lists

To add or remove packages from the artaverse:

  1. Edit the package lists in R/packages.R:
  2. Update DESCRIPTION Imports/Suggests accordingly
  3. Update documentation
  4. Run devtools::document() and devtools::check()

Adding New Packages to Core

When adding to core: 1. Add to artaverse_core() in R/packages.R 2. Add to Imports: in DESCRIPTION 3. Add to Remotes: in DESCRIPTION with artalytics/{package} 4. Update documentation

Adding New Packages to Extended

When adding to extended: 1. Add to artaverse_extended() in R/packages.R 2. Add to Suggests: in DESCRIPTION 3. Update documentation

Docker Deployment

artaverse includes a Dockerfile for containerized deployment of the complete R development environment.

Quick Start 

# Set your GitHub PAT
export GITHUB_PAT=your_github_token

# Build the image
./inst/docker-build.sh

# Run interactive R session with artaverse loaded
docker run -it artaverse:latest

What’s Included

The Docker image provides: - Complete R installation (base + development tools) - All artaverse packages (core + extended) - All dependencies ready for development, testing, and deployment

Documentation

See inst/DOCKER.md for complete Docker deployment guide including: - Build instructions - Usage examples
- Package inventory generation - Troubleshooting

Additional Resources

  • Organization Standards: Organization Guide
  • Repository Guidance: Repository Agents Guidance

License

This project is licensed under the terms specified in the LICENSE file.