Package: framework 1.0.2

Erik Westlund

framework: Structured Data Science Project Scaffolding

Project scaffolding and workflow tools for reproducible data science. Manages packages, tracks data integrity, handles database connections, generates notebooks, and publishes to S3-compatible storage. More information at <https://framework.table1.org>.

Authors:Erik Westlund [aut, cre, cph]

framework_1.0.2.tar.gz
framework_1.0.2.zip(r-4.7)framework_1.0.2.zip(r-4.6)framework_1.0.2.zip(r-4.5)
framework_1.0.2.tgz(r-4.6-any)framework_1.0.2.tgz(r-4.5-any)
framework_1.0.2.tar.gz(r-4.7-any)framework_1.0.2.tar.gz(r-4.6-any)
framework_1.0.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
framework/json (API)
NEWS

# Install 'framework' in R:
install.packages('framework', repos = c('https://table1.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/table1/framework/issues

On CRAN:

Conda:

5.07 score 1 stars 107 scripts 209 downloads 107 exports 54 dependencies

Last updated from:b9ef9f7691. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK199
source / vignettesOK259
linux-release-x86_64OK175
macos-release-arm64OK233
macos-oldrel-arm64OK164
windows-develOK179
windows-releaseOK203
windows-oldrelOK221
wasm-releaseOK167

Exports:.has_column.list_columns.list_tablesadd_project_to_configai_generate_contextai_regenerate_contextai_sync_contextbootstrap_project_initcachecache_flushcache_forgetcache_getcache_listcache_remembercapture_outputconfigure_globalconnections_listdata_adddata_infodata_listdata_readdata_savedb_connectdb_drivers_installdb_drivers_statusdb_executedb_listdb_querydb_transactiondb_withdocs_exportenv_clearenv_summaryfw_config_dirgit_addgit_commitgit_diffgit_hooks_disablegit_hooks_enablegit_hooks_installgit_hooks_listgit_hooks_uninstallgit_loggit_pullgit_pushgit_security_auditgit_statusguiload_settings_catalogmake_notebookmake_presentationmake_qmdmake_revealjsmake_rmdmake_scriptnewnew_coursenew_presentationnew_projectnew_project_sensitivenowpackages_installpackages_listpackages_restorepackages_snapshotpackages_statuspackages_updateproject_add_directoryproject_createproject_infoproject_listpublishpublish_datapublish_dirpublish_listpublish_notebookquarto_generate_allquarto_regenerateread_framework_templateread_frameworkrcremove_project_from_configrenv_disablerenv_enablerenv_enabledreset_framework_templateresult_listsave_figuresave_modelsave_notebooksave_reportsave_tablescaffoldscratch_capturescratch_cleansettingssettings_readsettings_writesetupstandardize_wdstatusstorage_teststubs_liststubs_pathstubs_publishviewwrite_framework_templatewrite_frameworkrc

Dependencies:askpassbackportsbitbit64blobcachemcheckmateclicliprcpp11crayoncurlDBIdotenvfastmapfsgenericsgluehmshttpuvjsonlitelaterlifecyclelubridatemagrittrmemoisemimeopensslotelpillarpkgconfigplumberprettyunitsprogresspromisesR6RcppreadrrlangRSQLitesodiumstringiswaggersystibbletidyselecttimechangetzdbutf8vctrsvroomwebutilswithryaml

Readme and manuals

Help Manual

Help pageTopics
Add project to global configurationadd_project_to_config
Generate AI Context Fileai_generate_context
Regenerate Dynamic Sections in AI Context Fileai_regenerate_context
Sync AI Assistant Context Filesai_sync_context
Cache a valuecache
Clear all cached valuescache_flush
Remove a cached valuecache_forget
Get a cached valuecache_get
List all cached valuescache_list
Remember a value (get from cache or compute and store)cache_remember
Capture console output and errors from an expressioncapture_output
Configure Global Framework Settingsconfigure_global
List all connections (databases and object storage)connections_list
S3 Connection Functionsconnections_s3
Add an existing file to the data catalogdata_add
Get data specification from configdata_info
List all data entries from configdata_list
Read data using dot notation path or direct file pathdata_read
Save data using dot notation or file pathdata_save
Get a database connectiondb_connect
Install database driversdb_drivers_install
Check if database drivers are installeddb_drivers_status
Execute a database statementdb_execute
List all database connections from configurationdb_list
Get data from a database querydb_query
Execute code within a database transactiondb_transaction
Execute code with a managed database connectiondb_with
Export Package Documentation to Databasedocs_export
Clear R environmentenv_clear
Summarize R environmentenv_summary
Get Framework config directory pathfw_config_dir
Stage Files for Commitgit_add
Commit Staged Changesgit_commit
Show Changes (Diff)git_diff
Disable Specific Git Hookgit_hooks_disable
Enable Specific Git Hookgit_hooks_enable
Install Git Pre-commit Hookgit_hooks_install
List Git Hook Statusgit_hooks_list
Uninstall Git Pre-commit Hookgit_hooks_uninstall
Show Commit Loggit_log
Pull from Remotegit_pull
Push to Remotegit_push
Security audit for Framework projectsgit_security_audit
Show Git Statusgit_status
Launch Framework GUIgui
Read the Framework settings catalogload_settings_catalog
Create a Notebook or Script from Stub Templatemake_notebook
Create a Presentationmake_presentation
Create a Quarto Notebookmake_qmd
Create a Reveal.js Presentationmake_revealjs
Create an RMarkdown Notebookmake_rmd
Create an R Script from Stub Templatemake_script
Create a New Project (Master Wrapper)new
Create a Course Projectnew_course
Create a Presentation Projectnew_presentation
Create a New Framework Projectnew_project
Create a Sensitive Data Projectnew_project_sensitive
Get current datetimenow
Output Save Functionsoutputs
Install packages from configurationpackages_install
List all packages from configurationpackages_list
Restore packages from renv.lockpackages_restore
Snapshot current package library (renv)packages_snapshot
Show renv package statuspackages_status
Update packages from configurationpackages_update
Display project structure informationproject_info
List all projects in global configurationproject_list
Publishing Functionspublish
Publish data to S3publish_data
Publish a directory to S3publish_dir
List published files in S3publish_list
Publish a Quarto notebook to S3publish_notebook
Generate Quarto Configurations for Projectquarto_generate_all
Regenerate Quarto Configurationsquarto_regenerate
Read the contents of a Framework templateread_framework_template
Read global Framework configurationread_frameworkrc
Remove project from global configurationremove_project_from_config
Disable renv for this projectrenv_disable
Enable renv for this projectrenv_enable
Check if renv is enabled for this projectrenv_enabled
Reset a Framework template back to the packaged defaultreset_framework_template
List saved results from the framework databaseresult_list
Save a figure to the outputs directorysave_figure
Save a model to the outputs directorysave_model
Save a rendered notebook to the outputs directorysave_notebook
Save a report to the outputs directorysave_report
Save a table to the outputs directorysave_table
Initialize and load the project environmentscaffold
Capture and Save Data to Filescratch_capture
Clean up the scratch directory by deleting all filesscratch_clean
Get settings value by dot-notation keysettings
Read project settingssettings_read
Write project settingssettings_write
Setup Framework (First-Time Configuration)setup
Standardize Working Directory for Framework Projectsstandardize_wd
Show Framework project statusstatus
Test storage connectionstorage_test
List Available Stubsstubs_list
Get Path to Stub Templates Directorystubs_path
Publish Stub Templates for Customizationstubs_publish
View data in an interactive browser viewerview
Overwrite a Framework template with new contentswrite_framework_template
Write global Framework configurationwrite_frameworkrc