Skip to contents

Get up and running with the Artalytics platform in under 5 minutes.

1. Install

# Install pak if you don't have it
install.packages("pak")

# Install the entire Artalytics platform
pak::pkg_install("artalytics/artaverse")

This single command installs approximately 180+ packages total:

Category Count Examples
Artalytics packages 18 artcore, artutils, appPlatform, modArtist, …
CRAN dependencies ~160 shiny, ggplot2, data.table, httr2, …
Base R (pre-installed) 1 Already on your system

Installation typically takes 5-10 minutes on a fresh R installation.

2. Load

#> ── Attaching Artalytics Platform artaverse 0.0.1 ──
#> ✔ artcore     1.3.0    ✔ modArtist   0.0.7
#> ✔ artutils    0.19.0   ✔ modBrowse   0.9.2
#> ✔ artshiny    0.1.1    ✔ modGallery  0.9.1
#> ✔ artauth     0.1.2    ✔ modUpload   0.9.1
#> ✔ appPlatform 0.9.1    ✔ modFrames   0.7.10
#>
#> ℹ Use artaverse_packages() to see all available packages
#> ℹ Use artaverse_versions() to check installed versions

All 10 core packages are now attached and ready to use.

3. Explore

See what’s available

# List all packages by category
artaverse_packages()
#> $core
#>  [1] "artcore"     "artutils"    "artauth"     "artshiny"    "appPlatform"
#>  [6] "modArtist"   "modBrowse"   "modGallery"  "modUpload"   "modFrames"
#>
#> $extended
#> [1] "arthelpers"   "artpipelines" "artbenchmark" "artcurator"
#> [5] "artopenai"    "artgemini"    "artopensea"   "artsend"

Check installed versions

#>        package version category
#>  1:    artcore   1.3.0     core
#>  2:   artutils  0.19.0     core
#>  3:   artshiny   0.1.1     core
#>  4:    artauth   0.1.2     core
#>  5: appPlatform  0.9.1     core
#>  ...

4. Use

Now you can use any function from the loaded packages:

# Database operations (artcore)
cn <- artcore::dbc()
artcore::dbd(cn)

# Data utilities (artutils)
artist <- artutils::get_artist_by_slug("bobby-fatemi")
stats <- artutils::get_artist_stats(artist$artist_uuid)

# Run the platform (appPlatform)
appPlatform::run_app()

What’s Next?

Quick Reference

Function Purpose
artaverse_packages() List all packages by category
artaverse_core() Get core package names
artaverse_extended() Get extended package names
artaverse_versions() Check installed versions
install_artaverse() Programmatic installation