Man pages for framework
Structured Data Science Project Scaffolding
| add_project_to_config | Add project to global configuration |
| 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 |
| bootstrap_project_init | Bootstrap project initialization file |
| cache | Cache a value |
| cache_flush | Clear all cached values |
| cache_forget | Remove a cached value |
| cache_get | Get a cached value |
| cache_list | List all cached values |
| cache_remember | Remember a value (get from cache or compute and store) |
| capture_output | Capture console output and errors from an expression |
| config | Get configuration value (alias for settings) |
| configure_ai_agents | Configure AI Assistant Support |
| configure_author | Configure Author Information |
| configure_connection | Configure Database Connection |
| configure_data | Configure Data Source |
| configure_directories | Configure Project Directories |
| configure_global | Configure Global Framework Settings |
| configure_packages | Configure Package Dependencies |
| connection_begin | Begin a database transaction |
| connection_check | Check if a connection is ready to use |
| connection_check_leaks | Check for leaked database connections |
| connection_close_all | Close all open database connections |
| connection_commit | Commit a database transaction |
| connection_delete | Delete a record from a table |
| connection_find | Find a record by ID |
| connection_find_by | Find records by column values |
| connection_insert | Insert a record into a table |
| connection_pool | Get or create a connection pool |
| connection_pool_close | Close a specific connection pool |
| connection_pool_close_all | Close all connection pools |
| connection_pool_list | List active connection pools |
| connection_restore | Restore a soft-deleted record |
| connection_rollback | Rollback a database transaction |
| connections_list | List all connections (databases and object storage) |
| connections_s3 | S3 Connection Functions |
| connection_update | Update a record in a table |
| connection_with_pool | Execute code with a connection pool |
| connection_with_transaction | Execute code with transaction if not already in one |
| data_add | Add an existing file to the data catalog |
| data_info | Get data specification from config |
| data_list | List all data entries from config |
| data_read | Read data using dot notation path or direct file path |
| data_read_or_cache | Read data with caching (DEPRECATED) |
| data_save | Save data using dot notation or file path |
| data_spec_get | Get data specification (DEPRECATED) |
| db_connect | Get a database connection |
| db_drivers_install | Install database drivers |
| db_drivers_status | Check if database drivers are installed |
| db_execute | Execute a database statement |
| db_list | List all database connections from configuration |
| db_query | Get data from a database query |
| db_transaction | Execute code within a database transaction |
| db_with | Execute code with a managed database connection |
| docs_export | Export Package Documentation to Database |
| dot-apply_auto_fix | Apply auto-fix for common issues |
| dot-build_directory_table | Build directory table from config |
| dot-calculate_file_hash | Calculate hash of a file |
| dot-catalog_field_default | Retrieve a default value from the catalog, falling back when... |
| dot-catalog_find_field | Convenience accessor for catalog field definitions |
| dot-catalog_project_type_defaults | Convert catalog project type metadata into default... |
| dot-check_duckdb_exists | Check if a DuckDB database exists |
| dot-check_env_gitignored | Check if .env is gitignored |
| dot-check_git_available | Check if git is available |
| dot-check_git_history | Check git history for leaked data files |
| dot-check_gitignore_coverage | Check gitignore coverage for data files |
| dot-check_git_status | Check git status and provide helpful reminder |
| dot-check_mysql_exists | Check if a MySQL/MariaDB database exists |
| dot-check_path_ignored | Check if path is ignored by .gitignore patterns |
| dot-check_postgres_exists | Check if a PostgreSQL database exists |
| dot-check_private_data_exposure | Check if private data is tracked by git |
| dot-check_sqlite_exists | Check if a SQLite database exists |
| dot-check_sqlserver_exists | Check if a SQL Server database exists |
| dot-cleanup_gitkeep_files | Remove .gitkeep files from data/ and functions/ directories |
| dot-collect_all_s3_connections | Collect all S3 connections from config |
| dot-commit_after_scaffold | Create initial commit after first successful scaffold |
| dot-configure_git_hooks | Configure git hooks based on environment variables |
| dot-connect_duckdb | Connect to a DuckDB database |
| dot-connect_mysql | Connect to a MySQL or MariaDB database |
| dot-connect_postgres | Connect to a PostgreSQL database |
| dot-connect_sqlite | Connect to a SQLite database |
| dot-connect_sqlserver | Connect to a SQL Server database |
| dot-copy_config_files | Copy config files between directories |
| dot-create_ai_files | Create AI context files |
| dot-create_ai_instructions | Create AI Assistant Instruction Files |
| dot-create_code_workspace | Create .code-workspace file for VSCode/Positron |
| dot-create_config_file | Create settings.yml from template |
| dot-create_dev_rprofile | Create development .Rprofile |
| dot-create_duckdb_db | Create a new DuckDB database |
| dot-create_gitignore | Create .gitignore file |
| dot-create_ide_configs | Create IDE configuration files |
| dot-create_init_file | Create init.R from template |
| dot-create_initial_commit | Create initial git commit after all initialization is... |
| dot-create_mysql_db | Create a new MySQL/MariaDB database |
| dot-create_postgres_db | Create a new PostgreSQL database |
| dot-create_project_config | Create project config.yml |
| dot-create_project_directories | Create project subdirectories |
| dot-create_renvignore | Create .renvignore file for Framework projects |
| dot-create_rproj_file | Create .Rproj file |
| dot-create_scaffold_file | Create scaffold.R file |
| dot-create_sqlite_db | Create a new SQLite database |
| dot-create_sqlserver_db | Create a new SQL Server database |
| dot-create_stub_files | Create stub files for specific project types |
| dot-create_template_db | Create the template SQLite database |
| dot-create_vscode_settings | Create VS Code settings.json |
| dot-create_vscode_workspace | Create VS Code workspace file |
| dot-customize_project_files | Customize project files with user-specific substitutions |
| dot-data_spec_update | Update data spec in the correct YAML file |
| dot-default_directory_table | Get default directory table for project type |
| dot-default_render_dirs_for_type | Resolve default render directory mappings for a project type... |
| dot-default_root_render_dir_for_type | Resolve default root render_dir (if defined) for a project... |
| dot-delete_init_file | Delete init.R after successful initialization |
| dot-df_to_list_of_lists | Convert data frame to list of lists for YAML serialization... |
| dot-display_next_steps | Display next steps after initialization |
| dot-ensure_framework_db | Ensure framework database exists with all required tables |
| dot-ensure_framework_template | Ensure the requested template exists in the user config... |
| dot-ensure_output_dir | Ensure a directory exists, creating it lazily with feedback |
| dot-find_project_root | Find project root by walking up directory tree |
| dot-find_stub_template | Find Stub Template |
| dot-framework_catalog_default_path | Get the path to the packaged settings catalog YAML |
| dot-framework_catalog_user_path | Get the path to the user-editable settings catalog override |
| dot-framework_templates_dir | Get the Framework templates directory |
| dot-generate_data_section | Generate Data Management section |
| dot-generate_environment_section | Generate Framework Environment section |
| dot-generate_function_reference | Generate Function Reference section |
| dot-generate_header_section | Generate header section |
| dot-generate_hook_script | Generate pre-commit hook script |
| dot-generate_notes_section | Generate notes section (user-editable) |
| dot-generate_packages_section | Generate Installed Packages section |
| dot-generate_project_type_section | Generate project-type specific section |
| dot-get_cache | Get a cache value |
| dot-get_cache_dir | Get the cache directory, respecting FW_CACHE_DIR environment... |
| dot-get_data_directories | Get data directories from config |
| dot-get_data_path_suggestions | Get suggestions for available data paths |
| dot-get_data_record | Get a data value |
| dot-get_db_connection | Get a connection to the framework database |
| dot-get_driver_info | Get driver information for a given database type |
| dot-get_example_data_path | Get example data path based on config |
| dot-get_hook_setting | Get git hook setting with optional alias fallback |
| dot-get_metadata | Get a metadata value |
| dot-get_notebook_dir_from_config | Get Notebook Directory from Config |
| dot-get_package_list_from_config | Extract package list from config |
| dot-get_package_requirements | Get package requirements from config |
| dot-get_placeholders | Generate database-appropriate parameter placeholders |
| dot-get_scaffold_history | Retrieve scaffold metadata from the database |
| dot-get_settings_file | Get settings file path |
| dot-git_available | Check if git is available on the system |
| dot-guess_content_type | Guess content type from file extension |
| dot-has_column | Check if a column exists in a table (S3 generic) |
| dot-has_settings_file | Check if settings file exists |
| dot-identify_private_dirs | Identify directories that should be treated as... |
| dot-init_db | Initialize the framework database |
| dot-init_git_repo | Initialize git repository |
| dot-init_renv | Initialize renv |
| dot-init_standard | Standard initialization process (shared by both paths) |
| dot-install_package | Install a package if not already installed |
| dot-install_package_base | Install package without renv |
| dot-install_package_renv | Install package via renv |
| dot-install_required_packages | Install required packages from config |
| dot-is_data_file | Check if file is a data file based on extension |
| dot-is_git_repo | Check if current directory is a git repository |
| dot-is_initialized | Check if project is initialized |
| dot-list_available_stubs | List Available Stub Templates |
| dot-list_columns | List all columns in a table (S3 generic) |
| dot-list_tables | List all tables in a database (S3 generic) |
| dot-load_ai_template | Load AI context template for a project type |
| dot-load_configuration | Load configuration from settings file |
| dot-load_environment | Load environment variables from .env file |
| dot-load_functions | Load all R files from functions directories |
| dot-load_libraries | Load all libraries specified in config |
| dot-load_template_content | Load template content from inst/templates |
| dot-make_env | Create or append to .env file |
| dot-mark_scaffolded | Mark project as scaffolded |
| dot-migrate_config_from_previous | Migrate config from previous R versions or legacy location |
| dot-normalize_expire_after | Normalize expire_after input to numeric hours |
| dot-normalize_notebook_name | Normalize Notebook Name and Detect Type |
| dot-normalize_package_spec | Normalize package specification from config |
| dot-parse_assistant_selection | Parse Assistant Selection from User Input |
| dot-parse_package_spec | Parse package specification with source detection |
| dot-parse_sections | Parse markdown into sections based on ## headings |
| dot-pretty_print_config | Pretty-print configuration values (internal) |
| dot-print_audit_summary | Print audit summary |
| dot-prompt_ai_support_init | Get AI Support Preferences (Non-interactive) |
| dot-prompt_ai_support_install | Set AI Support Preferences (Non-interactive) |
| dot-read_framework_template | Read a framework template |
| dot-remove_cache | Remove a cache value |
| dot-remove_data | Remove a data value |
| dot-remove_init | Remove initialization |
| dot-remove_metadata | Remove a metadata value |
| dot-replace_moustache_placeholders | Replace moustache-style placeholders in template content |
| dot-replace_section | Replace content of a specific section |
| dot-require_driver | Check if a database driver package is available |
| dot-require_git_repo | Require git repository or stop |
| dot-reset_framework_template | Reset a template back to its packaged default |
| dot-s3_client | Create an S3 client from connection configuration |
| dot-s3_public_url | Generate public URL for S3 object |
| dot-s3_upload_dir | Upload a directory to S3 |
| dot-s3_upload_file | Upload a file to S3 |
| dot-save_audit_result | Save audit result to framework database |
| dot-save_result | Log a saved result to the framework database |
| dot-scan_for_orphaned_files | Scan for orphaned data files outside configured directories |
| dot-set_cache | Set a cache value |
| dot-set_data | Set a data value |
| dot-set_ggplot_theme | Set ggplot2 theme for consistent styling |
| dot-set_metadata | Set a metadata value |
| dot-set_random_seed | Set random seed for reproducibility |
| dot-slugify | Slugify a String |
| dot-sync_packages_to_renv | Sync packages from settings.yml to renv |
| dot-to_kebab_case | Convert string to kebab-case |
| dot-update_data_with_hash | Update data with hash in the data table |
| dot-update_frameworkrc | Update ~/.frameworkrc with AI Preferences |
| dot-update_gitignore_for_renv | Update .gitignore for renv |
| dot-update_hook_config | Update hook configuration in settings.yml/settings.yml |
| dot-uses_split_file | Determine if a project field uses split file or inline... |
| dot-validate_driver | Validate driver availability before connection |
| dot-validate_refresh | Validate refresh parameter |
| dot-validate_settings_catalog | Basic validation for the settings catalog structure |
| dot-write_framework_template | Write (overwrite) a framework template |
| env_clear | Clear R environment |
| env_default_template_lines | Default Framework .env template lines |
| env_lines_from_variables | Convert env() configuration into file lines |
| env_resolve_lines | Resolve env template lines from configuration |
| env_summary | Summarize R environment |
| framework-package | framework: Structured Data Science Project Scaffolding |
| framework_template_path | Get the user-editable path for a Framework template |
| framework_view | (Deprecated) Use view_create() or view_detail() instead |
| fw_config_dir | Get Framework config directory path |
| get_default_global_config | Get default global configuration structure |
| get_global_setting | Get Global Configuration Setting |
| git_add | Stage Files for Commit |
| git_commit | Commit Staged Changes |
| 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 |
| git_status | Show Git Status |
| gui | Launch Framework GUI |
| init_global_config | Initialize global Framework settings |
| list_framework_templates | List available framework templates |
| list_metadata | List all metadata |
| load_settings_catalog | Read the Framework settings catalog |
| make_notebook | Create a Notebook or Script from Stub Template |
| make_presentation | Create a Presentation |
| make_qmd | Create a Quarto Notebook |
| make_revealjs | Create a Reveal.js Presentation |
| make_rmd | Create an RMarkdown Notebook |
| make_script | Create an R Script from Stub Template |
| 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 |
| now | Get current datetime |
| outputs | Output Save Functions |
| packages_install | Install packages from configuration |
| packages_list | List all packages from configuration |
| packages_restore | Restore packages from renv.lock |
| packages_snapshot | Snapshot current package library (renv) |
| packages_status | Show renv package status |
| packages_update | Update packages from configuration |
| project_add_directory | Add custom directories to an existing project |
| project_create | Create a new Framework project (internal) |
| project_info | Display project structure information |
| project_list | List all projects in global configuration |
| publish | Publishing Functions |
| publish_data | Publish data to S3 |
| publish_dir | Publish a directory to S3 |
| publish_list | List published files in S3 |
| publish_notebook | Publish a Quarto notebook to S3 |
| quarto_generate_all | Generate Quarto Configurations for Project |
| quarto_regenerate | Regenerate Quarto Configurations |
| read_frameworkrc | Read global Framework configuration |
| read_framework_template | Read the contents of a Framework template |
| remove_project_from_config | Remove project from global 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 |
| renv_restore | Restore packages from renv.lock |
| renv_snapshot | Snapshot current package versions to renv.lock |
| renv_status | Show package status |
| renv_sync | Sync packages with renv.lock |
| renv_update | Update packages |
| reset_framework_template | Reset a Framework template back to the packaged default |
| result_list | List saved results from the framework database |
| save_figure | Save a figure to the outputs directory |
| save_model | Save a model to the outputs directory |
| save_notebook | Save a rendered notebook to the outputs directory |
| save_report | Save a report to the outputs directory |
| save_table | Save a table to the outputs directory |
| scaffold | Initialize and load the project environment |
| scratch_capture | Capture and Save Data to File |
| scratch_clean | Clean up the scratch directory by deleting all files |
| settings | Get settings value by dot-notation key |
| settings_read | Read project settings |
| settings_write | Write project settings |
| setup | Setup Framework (First-Time Configuration) |
| standardize_wd | Standardize Working Directory for Framework Projects |
| status | Show Framework project status |
| storage_test | Test storage connection |
| stubs_list | List Available Stubs |
| stubs_path | Get Path to Stub Templates Directory |
| stubs_publish | Publish Stub Templates for Customization |
| view | View data in an interactive browser viewer |
| view_create | Create an enhanced view of R objects in the browser |
| view_detail | View data with enhanced browser-based interface |
| write_frameworkrc | Write global Framework configuration |
| write_framework_template | Overwrite a Framework template with new contents |
