Skip to contents

arthelpers

R Package Version

arthelpers is an internal developer tools package for Artalytics R package development. It provides utilities that streamline common development tasks including environment diagnostics, GitHub repository management, Shiny app visual testing, package documentation setup, and test data cleanup.

Installation 

# Install from GitHub (requires GITHUB_PAT)
pak::pkg_install("artalytics/arthelpers")

Environment Variables

arthelpers requires minimal configuration:

Variable Required For Description
GITHUB_PAT get_repo_index() GitHub Personal Access Token for API authentication

Database functions inherit variables from artcore (see artcore README):

Variable Required For Description
ART_PGDATA delete_*() PostgreSQL database name (via artcore)
ART_PGHOST delete_*() Database host (via artcore)
ART_PGPORT delete_*() Database port (via artcore)
ART_PGUSER delete_*() Database user (via artcore)
ART_PGPASS delete_*() Database password (via artcore)

Quick Example 

library(arthelpers)

# Setup package branding (logo + favicons)
setup_favicon()

# Diagnose development environment
describe_env()

# Screenshot a Shiny app for documentation
app <- shiny::shinyApp(
  ui = shiny::fluidPage(shiny::h1("Test App")),
  server = function(input, output) {}
)
screenshot_app(app, file = "docs/app-preview.png")

# List organization repositories
repos <- get_repo_index()
print(repos)

# Clean up test data
delete_artwork(
  artwork = "99a61148-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  delete_cdn = TRUE
)

Package Position

arthelpers is a development-time meta tool in platform/misc/, not part of the production dependency chain:

appPlatform / mod* packages (application layer)
        |
    artutils (data access layer)
        |
    artcore (infrastructure layer)

    arthelpers  ← Development tools (misc/)

arthelpers depends on artcore (for database operations), shiny (for screenshot testing), and pkgdown (for documentation setup). It is used during package development but not deployed to production.

Documentation

Development

For AI agent instructions and coding standards, see AGENTS.md.

Proprietary - Do Not Distribute