README.md

In PHACDataHub/metabaserer: Metabaser

metabaserer

metabaserer is an R package to connect to and query a Metabase API. It improves on the previous metabaser package, and (presumably) will someday be subsumed by metabaserest.

Installation

If you're not already comfortable with devtools, the simplest way to install the package is directly from github using remotes (a subset of devtools for installing non-CRAN packages).

library(remotes)
install_github("PHACDataHub/metabaserer")

Usage

# login and setup connection
metabase_login(base_url = "https://discover-metabase.hres.ca/api",
               database_id = 2, # phac database
               creds_file = "~/metabase_creds", # a file with username and password 
               username = "METABASE_USERNAME",
               password = "METABASE_PASSWORD")


# query
df <- metabase_query("select * from table;") 

typed_df <-metabase_query("select * from table;", col_types = cols(.default = col_character())) #sets the default type to character to avoid parsing failures

small_df <- metabase_query2("select * from table;") #limits to 2K records, used for quick queries

# logout
metabase_logout()

PHACDataHub/metabaserer documentation built on March 14, 2021, 12:02 a.m.