Implement functions returning database connection, not table - Githubissues

Metropolitan-Council / councilR

A curated collection of commonly used templates, color palettes, functions, and more!

Other

6 stars 1 forks source link

Implement functions returning database connection, not table #68

Closed eroten closed 9 months ago

eroten commented 9 months ago

This PR makes available functions that return a database connection object, while retaining functions that return a table.

New functions established

gis_connection() create connection to GISLibrary
emissions_connection() create connection to emissions
fred_connection() creates connection to FRED. FRED_connection() also works.

These functions are written in the same .R file as their import_from___() counterpart, to keep organization consistent.

R/ files re-named

import_from_gis.R -> db_gis.R
import_from_fred.R -> db_FRED.R
import_from_emissions.R -> db_emissions.R

Additional changes

replace stop() with cli::cli_abort()
add roxygen family "database functions"
documentation improvements across package
testing updates and improvements
import_from_gpkg() has new alias, import_gpkg().
New "Databases" vignette with brief summaries of each