Package index • putior

Core Functions

Main functions for extracting annotations and creating diagrams

put(): Scan R and Python Files for PUT Annotations

put_diagram(): Create Mermaid Diagram from PUT Workflow

Helper Functions

Supporting functions for processing annotations

parse_put_annotation(): Extract PUT Annotation Properties

validate_annotation(): Validate PUT annotation for common issues

is_valid_put_annotation(): Validate PUT annotation syntax

process_single_file(): Process a single file for PUT annotations

split_file_list(): Split comma-separated file list

Diagram Generation

Functions for creating Mermaid diagrams

generate_node_definitions(): Generate node definitions for mermaid diagram

generate_connections(): Generate connections between nodes

generate_node_styling(): Generate node styling based on node types and theme

create_artifact_nodes(): Create artifact nodes for data files

get_diagram_themes(): Get available themes for put_diagram

get_theme_colors(): Get color schemes for different themes (FIXED VERSION)

get_node_shape(): Get node shape characters based on node type

sanitize_node_id(): Sanitize node ID for mermaid compatibility (IMPROVED VERSION)

Data Processing

Functions for handling results

convert_results_to_df(): Convert results list to data frame

empty_result_df(): Create empty result data frame

handle_output(): Handle diagram output to different destinations

parse_comma_separated_pairs(): Parse comma-separated pairs while respecting quotes