API for framework
Structured Data Science Project Scaffolding

Global functions
.apply_auto_fix Man page Source code
.build_directory_table Man page Source code
.calculate_file_hash Man page Source code
.catalog_field_default Man page Source code
.catalog_find_field Man page Source code
.catalog_project_type_defaults Man page Source code
.check_duckdb_exists Man page Source code
.check_env_gitignored Man page Source code
.check_git_available Man page Source code
.check_git_history Man page Source code
.check_git_status Man page Source code
.check_gitignore_coverage Man page Source code
.check_mysql_exists Man page Source code
.check_path_ignored Man page Source code
.check_postgres_exists Man page Source code
.check_private_data_exposure Man page Source code
.check_sqlite_exists Man page Source code
.check_sqlserver_exists Man page Source code
.cleanup_gitkeep_files Man page Source code
.collect_all_s3_connections Man page Source code
.commit_after_scaffold Man page Source code
.configure_git_hooks Man page Source code
.connect_duckdb Man page Source code
.connect_mysql Man page Source code
.connect_postgres Man page Source code
.connect_sqlite Man page Source code
.connect_sqlserver Man page Source code
.copy_config_files Man page Source code
.create_ai_files Man page Source code
.create_ai_instructions Man page Source code
.create_code_workspace Man page Source code
.create_config_file Man page Source code
.create_connections_file Source code
.create_dev_rprofile Man page Source code
.create_docs_schema Source code
.create_duckdb_db Man page Source code
.create_env_file Source code
.create_gitignore Man page Source code
.create_ide_configs Man page Source code
.create_init_file Man page Source code
.create_initial_commit Man page Source code
.create_mysql_db Man page Source code
.create_pool_duckdb Source code
.create_pool_mysql Source code
.create_pool_postgres Source code
.create_pool_sqlite Source code
.create_pool_sqlserver Source code
.create_postgres_db Man page Source code
.create_project_config Man page Source code
.create_project_directories Man page Source code
.create_renvignore Man page Source code
.create_rproj_file Man page Source code
.create_scaffold_file Man page Source code
.create_sqlite_db Man page Source code
.create_sqlserver_db Man page Source code
.create_stub_files Man page Source code
.create_template_db Man page Source code
.create_vscode_settings Man page Source code
.create_vscode_workspace Man page Source code
.customize_project_files Man page Source code
.data_spec_update Man page Source code
.default_connections_configuration Source code
.default_directory_table Man page Source code
.default_render_dirs_for_type Man page Source code
.default_root_render_dir_for_type Man page Source code
.delete_init_file Man page Source code
.df_to_list_of_lists Man page Source code
.display_next_steps Man page Source code
.ensure_biocmanager_installed Source code
.ensure_framework_db Man page Source code
.ensure_framework_template Man page Source code
.ensure_notebook_output_dir Source code
.ensure_output_dir Man page Source code
.eval_expressions Source code
.export_examples Source code
.export_rd_file Source code
.export_section Source code
.export_seealso Source code
.find_project_root Man page Source code
.find_stub_template Man page Source code
.format_scaffold_timestamp Source code
.framework_catalog_default_path Man page Source code
.framework_catalog_user_path Man page Source code
.framework_template_default_path Source code
.framework_template_path Source code
.framework_templates_dir Man page Source code
.generate_data_section Man page Source code
.generate_environment_section Man page Source code
.generate_function_reference Man page Source code
.generate_header_section Man page Source code
.generate_hook_script Man page Source code
.generate_notes_section Man page Source code
.generate_packages_section Man page Source code
.generate_project_type_section Man page Source code
.get_cache Man page Source code
.get_cache_dir Man page Source code
.get_data_directories Man page Source code
.get_data_path_suggestions Man page Source code
.get_data_record Man page Source code
.get_db_connection Man page Source code
.get_driver_info Man page Source code
.get_example_data_path Man page Source code
.get_hook_setting Man page Source code
.get_metadata Man page Source code
.get_notebook_dir_from_config Man page Source code
.get_package_list_from_config Man page Source code
.get_package_requirements Man page Source code
.get_placeholders Man page Source code
.get_scaffold_history Man page Source code
.get_settings_file Man page Source code
.git_available Man page Source code
.guess_content_type Man page Source code
.has_column Man page Source code
.has_column.MariaDBConnection Man page Source code
.has_column.Microsoft SQL Server Man page
.has_column.PqConnection Man page Source code
.has_column.SQLiteConnection Man page Source code
.has_column.default Man page Source code
.has_column.duckdb_connection Man page Source code
.has_environment_sections Source code
.has_settings_file Man page Source code
.identify_private_dirs Man page Source code
.init_db Man page Source code
.init_git_repo Man page Source code Source code
.init_renv Man page Source code
.init_standard Man page Source code
.initialize_env_file Source code
.initialize_framework_db Source code
.insert_categories Source code
.install_package Man page Source code
.install_package_base Man page Source code
.install_package_renv Man page Source code
.install_required_packages Man page Source code
.is_data_file Man page Source code
.is_git_repo Man page Source code
.is_initialized Man page Source code
.list_available_stubs Man page Source code
.list_columns Man page Source code
.list_columns.MariaDBConnection Man page Source code
.list_columns.Microsoft SQL Server Man page
.list_columns.PqConnection Man page Source code
.list_columns.SQLiteConnection Man page Source code
.list_columns.default Man page Source code
.list_columns.duckdb_connection Man page Source code
.list_tables Man page Source code
.list_tables.default Man page Source code
.load_ai_template Man page Source code
.load_category_map Source code
.load_configuration Man page Source code
.load_environment Man page Source code
.load_functions Man page Source code
.load_libraries Man page Source code
.load_template_content Man page Source code
.make_env Man page Source code
.mark_scaffolded Man page Source code
.migrate_config_from_previous Man page Source code
.normalize_expire_after Man page Source code
.normalize_notebook_name Man page Source code
.normalize_package_list_spec Source code
.normalize_package_spec Man page Source code
.normalize_package_string_spec Source code
.normalize_prose Source code
.onAttach Source code
.onLoad Source code
.parse_assistant_selection Man page Source code
.parse_package_spec Man page Source code
.parse_scaffold_marker_lines Source code
.parse_scaffold_timestamp Source code
.parse_sections Man page Source code
.path_to_tilde Source code
.pretty_print_config Man page Source code
.print_audit_summary Man page Source code
.process_packages Source code
.prompt_ai_support_init Man page Source code
.prompt_ai_support_install Man page Source code
.rd_get_tag Source code
.rd_get_text Source code
.rd_render_content Source code
.read_framework_template Man page Source code
.remove_cache Man page Source code
.remove_data Man page Source code
.remove_init Man page Source code
.remove_metadata Man page Source code
.replace_author_placeholders Source code
.replace_moustache_placeholders Man page Source code
.replace_section Man page Source code
.require_driver Man page Source code
.require_git_repo Man page Source code
.reset_framework_template Man page Source code
.resolve_file_path Source code
.resolve_project_author Source code
.resolve_s3_connection Source code
.resolve_split_files Source code
.s3_client Man page Source code
.s3_public_url Man page Source code
.s3_upload_dir Man page Source code
.s3_upload_file Man page Source code
.safe_read_yaml Source code
.save_audit_result Man page Source code
.save_result Man page Source code
.scan_for_orphaned_files Man page Source code
.set_cache Man page Source code
.set_data Man page Source code
.set_ggplot_theme Man page Source code
.set_metadata Man page Source code
.set_random_seed Man page Source code
.slugify Man page Source code
.sync_packages_to_renv Man page Source code
.to_kebab_case Man page Source code
.update_data_with_hash Man page Source code Source code
.update_frameworkrc Man page Source code
.update_gitignore_for_renv Man page Source code
.update_hook_config Man page Source code
.update_quarto_output_dir Source code
.uses_split_file Man page Source code
.validate_active_project Source code
.validate_author Source code
.validate_defaults Source code
.validate_driver Man page Source code
.validate_git_profile Source code
.validate_privacy Source code
.validate_project_types Source code
.validate_projects Source code
.validate_projects_root Source code
.validate_refresh Man page Source code
.validate_settings_catalog Man page Source code
.write_framework_template Man page Source code
`%||%` Source code
`.has_column.Microsoft SQL Server` Source code
`.list_columns.Microsoft SQL Server` Source code
add_project_to_config Man page Source code
ai_generate_context Man page Source code
ai_regenerate_context Man page Source code
ai_sync_context Man page Source code
bootstrap_project_init Man page Source code
cache Man page Source code
cache_flush Man page Source code
cache_forget Man page Source code
cache_get Man page Source code
cache_list Man page Source code
cache_remember Man page Source code
capture_output Man page Source code
config Man page Source code
configure_ai_agents Man page Source code
configure_author Man page Source code
configure_connection Man page Source code
configure_data Man page Source code
configure_directories Man page Source code
configure_global Man page Source code
configure_packages Man page Source code
connection_begin Man page Source code
connection_check Man page Source code
connection_check_leaks Man page Source code
connection_close_all Man page Source code
connection_commit Man page Source code
connection_delete Man page Source code
connection_find Man page Source code
connection_find_by Man page Source code
connection_insert Man page Source code
connection_pool Man page Source code
connection_pool_close Man page Source code
connection_pool_close_all Man page Source code
connection_pool_list Man page Source code
connection_restore Man page Source code
connection_rollback Man page Source code
connection_update Man page Source code
connection_with_pool Man page Source code
connection_with_transaction Man page Source code
connections_list Man page Source code
connections_s3 Man page
data_add Man page Source code
data_info Man page Source code
data_list Man page Source code
data_read Man page Source code
data_read_or_cache Man page Source code
data_save Man page Source code
data_spec_get Man page Source code
db_connect Man page Source code
db_drivers_install Man page Source code
db_drivers_status Man page Source code
db_execute Man page Source code
db_list Man page Source code
db_query Man page Source code
db_transaction Man page Source code
db_with Man page Source code
determine_render_format Source code
docs_export Man page Source code
dot-has_column Man page
dot-list_columns Man page
dot-list_tables Man page
env_clear Man page Source code
env_default_template_lines Man page Source code
env_lines_from_variables Man page Source code
env_resolve_lines Man page Source code
env_summary Man page Source code
framework Man page
framework-package Man page
framework_template_path Man page Source code
framework_view Man page Source code
fw_config_dir Man page Source code
generate_quarto_yml Source code
get_default_global_config Man page Source code
get_default_quarto_settings Source code
get_global_setting Man page Source code
git_add Man page Source code
git_commit Man page Source code
git_diff Man page Source code
git_hooks_disable Man page Source code
git_hooks_enable Man page Source code
git_hooks_install Man page Source code
git_hooks_list Man page Source code
git_hooks_uninstall Man page Source code
git_log Man page Source code
git_pull Man page Source code
git_push Man page Source code
git_security_audit Man page Source code
git_status Man page Source code
gui Man page Source code
init_global_config Man page Source code
list_data Source code
list_framework_templates Man page Source code
list_metadata Man page Source code
load_settings_catalog Man page Source code
make_notebook Man page Source code
make_presentation Man page Source code
make_qmd Man page Source code
make_revealjs Man page Source code
make_rmd Man page Source code
make_script Man page Source code
new Man page Source code
new_course Man page Source code
new_presentation Man page Source code
new_project Man page Source code
new_project_sensitive Man page Source code
now Man page Source code
outputs Man page
packages_install Man page Source code
packages_list Man page Source code
packages_restore Man page Source code
packages_snapshot Man page Source code
packages_status Man page Source code
packages_update Man page Source code
project_add_directory Man page Source code
project_create Man page Source code
project_info Man page Source code
project_list Man page Source code
publish Man page Source code
publish_data Man page Source code
publish_dir Man page Source code
publish_list Man page Source code
publish_notebook Man page Source code
quarto_generate_all Man page Source code
quarto_regenerate Man page Source code
read_framework_template Man page Source code
read_frameworkrc Man page Source code
remove_project_from_config Man page Source code
renv_disable Man page Source code
renv_enable Man page Source code
renv_enabled Man page Source code
renv_restore Man page Source code
renv_snapshot Man page Source code
renv_status Man page Source code
renv_sync Man page Source code
renv_update Man page Source code
reset_framework_template Man page Source code
result_list Man page Source code
save_figure Man page Source code
save_model Man page Source code
save_notebook Man page Source code
save_report Man page Source code
save_table Man page Source code
scaffold Man page Source code
scratch_capture Man page Source code
scratch_clean Man page Source code
settings Man page Source code
settings_read Man page Source code
settings_write Man page Source code
setup Man page Source code
standardize_wd Man page Source code
status Man page Source code
storage_test Man page Source code
stubs_list Man page Source code
stubs_path Man page Source code
stubs_publish Man page Source code
view Man page Source code
view_create Man page Source code
view_detail Man page Source code
write_framework_template Man page Source code
write_frameworkrc Man page Source code
write_quarto_yml Source code
framework documentation built on Feb. 18, 2026, 1:07 a.m.