Workflow
Setting up and managing the working environment
Common Functions
These are the most commonly used functions in this category:
gui()
Opens a beautiful web-based interface for Framework with documentation, project management, and set
scaffold()
The primary entry point for working with Framework projects. Call this at the start of every notebo
settings()
Framework's primary configuration helper that supports both flat and hierarchical key access using
setup()
Initializes Framework's global configuration and launches the GUI for first-time setup. This is the
Other Functions
| Function | Description |
|---|---|
| capture_output() | Capture console output and errors from an expression |
| env_clear() | Cleans up the R environment by removing objects, closing plots, detaching packages, and running gar |
| env_summary() | Displays a summary of the current R environment including loaded packages, objects in the global en |
| now() | Get current datetime |
| scratch_capture() | Saves data to a file in various formats based on the object type and specified format. If no name i |
| scratch_clean() | Clean up the scratch directory by deleting all files |
| settings_read() | Reads the project settings from settings.yml or config.yml with environment-aware merging and split |
| settings_write() | Writes the project settings to settings.yml or config files |
| standardize_wd() | This function helps standardize the working directory when working with framework projects, especia |
| view_create() | Opens an interactive, browser-based viewer for R objects with syntax highlighting, tabbed interface |
| view_detail() | Opens an interactive, browser-based viewer for R objects with search, filtering, sorting, paginatio |
All Functions
| Function | Description |
|---|---|
| capture_output() | Capture console output and errors from an expression |
| env_clear() | Cleans up the R environment by removing objects, closing plots, detaching packages, and running gar |
| env_summary() | Displays a summary of the current R environment including loaded packages, objects in the global en |
| gui() | Opens a beautiful web-based interface for Framework with documentation, project management, and set |
| now() | Get current datetime |
| scaffold() | The primary entry point for working with Framework projects. Call this at the start of every notebo |
| scratch_capture() | Saves data to a file in various formats based on the object type and specified format. If no name i |
| scratch_clean() | Clean up the scratch directory by deleting all files |
| settings() | Framework's primary configuration helper that supports both flat and hierarchical key access using |
| settings_read() | Reads the project settings from settings.yml or config.yml with environment-aware merging and split |
| settings_write() | Writes the project settings to settings.yml or config files |
| setup() | Initializes Framework's global configuration and launches the GUI for first-time setup. This is the |
| standardize_wd() | This function helps standardize the working directory when working with framework projects, especia |
| view_create() | Opens an interactive, browser-based viewer for R objects with syntax highlighting, tabbed interface |
| view_detail() | Opens an interactive, browser-based viewer for R objects with search, filtering, sorting, paginatio |