Reference
Every public function, by category.
Workflow
Setting up and managing the working environment
Common
- gui()
- Launch Framework GUI
- scaffold()
- Initialize and load the project environment
- settings()
- Get settings value by dot-notation key
- setup()
- Setup Framework (First-Time Configuration)
More
- add_project_to_config()
- Add project to global configuration
- capture_output()
- Capture console output and errors from an expression
- configure_global()
- Configure Global Framework Settings
- connections_list()
- List all connections (databases and object storage)
- docs_export()
- Export Package Documentation to Database
- env_clear()
- Clear R environment
- env_summary()
- Summarize R environment
- fw_config_dir()
- Get Framework config directory path
- load_settings_catalog()
- Read the Framework settings catalog
- now()
- Get current datetime
- read_framework_template()
- Read the contents of a Framework template
- read_frameworkrc()
- Read global Framework configuration
- remove_project_from_config()
- Remove project from global configuration
- reset_framework_template()
- Reset a Framework template back to the packaged default
- scratch_capture()
- Capture and Save Data to File
- scratch_clean()
- Clean up the scratch directory by deleting all files
- settings_read()
- Read project settings
- settings_write()
- Write project settings
- standardize_wd()
- Standardize Working Directory for Framework Projects
- view()
- View data in an interactive browser viewer
- write_framework_template()
- Overwrite a Framework template with new contents
- write_frameworkrc()
- Write global Framework configuration
Data
Reading, writing, and managing data files
Common
- data_add()
- Add an existing file to the data catalog
- data_list()
- List all data entries from config
- data_read()
- Read data using dot notation path or direct file path
- data_save()
- Save data using dot notation or file path
More
- data_info()
- Get data specification from config
Packages
Package management and renv integration
Common
- packages_install()
- Install packages from configuration
- packages_restore()
- Restore packages from renv.lock
More
- packages_list()
- List all packages from configuration
- packages_snapshot()
- Snapshot current package library (renv)
- packages_status()
- Show renv package status
- packages_update()
- Update packages from configuration
- renv_disable()
- Disable renv for this project
- renv_enable()
- Enable renv for this project
- renv_enabled()
- Check if renv is enabled for this project
Saving Work
Saving figures, tables, reports, and models
Common
- save_figure()
- Save a figure to the outputs directory
- save_model()
- Save a model to the outputs directory
- save_report()
- Save a report to the outputs directory
More
- result_list()
- List saved results from the framework database
- save_notebook()
- Save a rendered notebook to the outputs directory
- save_table()
- Save a table to the outputs directory
Notebooks & Scripts
Creating notebooks, scripts, and presentations
Common
- make_notebook()
- Create a Notebook or Script from Stub Template
- make_presentation()
- Create a Presentation
- make_script()
- Create an R Script from Stub Template
More
- make_qmd()
- Create a Quarto Notebook
- make_revealjs()
- Create a Reveal.js Presentation
- make_rmd()
- Create an RMarkdown Notebook
- quarto_generate_all()
- Generate Quarto Configurations for Project
- quarto_regenerate()
- Regenerate Quarto Configurations
- stubs_list()
- List Available Stubs
- stubs_path()
- Get Path to Stub Templates Directory
- stubs_publish()
- Publish Stub Templates for Customization
Project Management
Creating and managing projects
Common
- new()
- Create a New Project (Master Wrapper)
- new_course()
- Create a Course Project
- new_presentation()
- Create a Presentation Project
- new_project()
- Create a New Framework Project
- new_project_sensitive()
- Create a Sensitive Data Project
More
- project_info()
- Display project structure information
- project_list()
- List all projects in global configuration
- status()
- Show Framework project status
Publishing
Publishing outputs and reports
Common
- publish()
- Publishing Functions
- publish_data()
- Publish data to S3
- publish_notebook()
- Publish a Quarto notebook to S3
More
- publish_dir()
- Publish a directory to S3
- publish_list()
- List published files in S3
- storage_test()
- Test storage connection
Git
Git commands and hook management
Common
- git_add()
- Stage Files for Commit
- git_commit()
- Commit Staged Changes
- git_status()
- Show Git Status
More
- git_diff()
- Show Changes (Diff)
- git_hooks_disable()
- Disable Specific Git Hook
- git_hooks_enable()
- Enable Specific Git Hook
- git_hooks_install()
- Install Git Pre-commit Hook
- git_hooks_list()
- List Git Hook Status
- git_hooks_uninstall()
- Uninstall Git Pre-commit Hook
- git_log()
- Show Commit Log
- git_pull()
- Pull from Remote
- git_push()
- Push to Remote
- git_security_audit()
- Security audit for Framework projects
Caching
Caching computed values for performance
Common
- cache()
- Cache a value
- cache_get()
- Get a cached value
- cache_remember()
- Remember a value (get from cache or compute and store)
More
- cache_flush()
- Clear all cached values
- cache_forget()
- Remove a cached value
- cache_list()
- List all cached values
Database
Database connections and queries
Common
- db_connect()
- Get a database connection
- db_execute()
- Execute a database statement
- db_query()
- Get data from a database query
More
- db_drivers_install()
- Install database drivers
- db_drivers_status()
- Check if database drivers are installed
- db_list()
- List all database connections from configuration
- db_transaction()
- Execute code within a database transaction
- db_with()
- Execute code with a managed database connection
AI
AI assistant integration
Common
- ai_skills_update()
- Update Framework Skills in a Project
More
- ai_generate_context()
- Generate AI Context File
- ai_regenerate_context()
- Regenerate Dynamic Sections in AI Context File
- ai_sync_context()
- Sync AI Assistant Context Files