Skip to content

csiapps

Helper functions and utilities for CSI data warehouse ingestion and Shiny web applications. csiapps ships as two packages with full feature parity — one for R, one for Python — so a team can work in either language against the same CSIAPPS warehouse and registration API.

This site documents both: every tutorial shows the R and the Python code side by side. Pick your language with the tabs and it stays selected across the whole page.

The library has three layers:

  • API client — make_request, fetch_org_options, fetch_profiles, fetch_profile, with OAuth2 PKCE auth.
  • Sandbox — a local, in-memory emulation of the warehouse and registration API so you can develop the full schema → ingest → retrieve workflow with no network and no credentials. Sandbox mode is on by default.
  • App wrapper — ui_wrapper / server_wrapper add a consistent CSI navbar/footer and handle authentication for a Shiny app.

Installation

# install.packages("remotes")
remotes::install_github("CSIOntario/csiapps-r")

pip install csiapps

Sandbox mode is the default

Every call routes to the local sandbox until you explicitly turn it off, so you never hit the production warehouse by accident:

library(csiapps)

is_sandbox_mode()   # TRUE

# Turn it off for deployment:
options(csiapps.sandbox = FALSE)   # or set CSIAPPS_ENV=production

import csiapps

csiapps.is_sandbox_mode()   # True

# Turn it off for deployment:
csiapps.set_sandbox_mode(False)          # or set CSIAPPS_ENV=production

Where to go next

  • Shiny apps — wrap an app's UI and server with CSIAPPS authentication and chrome.
  • REST API — make_request and the registration helpers.
  • Sandbox mode — the full local warehouse/registration workflow.
  • Parity checklist — how each R function maps to its Python equivalent.

Function reference