Provides contextual help and guidance for users to navigate the package effectively and find the right functions for their tasks. Show getting started guide
Displays a comprehensive getting started guide for new users
Examples
show_getting_started()
#>
#> Getting Started with engager
#> ============================
#>
#> BASIC WORKFLOW (5 steps):
#> 1. load_zoom_transcript() - Load your transcript file
#> 2. process_zoom_transcript() - Clean and prepare data
#> 3. analyze_transcripts() - Calculate engagement metrics
#> 4. plot_users() - Create charts and graphs
#> 5. write_metrics(..., path = 'your/output.csv') - Save to an explicit path
#>
#> QUICK START (Recommended for new users):
#> results <- basic_transcript_analysis('your_file.vtt')
#> # To export, supply output_dir = 'your/output/directory'
#>
#> STEP-BY-STEP WORKFLOW:
#> transcript <- load_zoom_transcript('your_file.vtt')
#> processed <- process_zoom_transcript(transcript_df = transcript)
#> analysis <- summarize_transcript_metrics(transcript_df = processed)
#> plots <- plot_users(analysis, metric = 'wordcount', facet_by = 'transcript_file')
#> write_metrics(analysis, path = 'output/engagement_metrics.csv')
#>
#> BATCH PROCESSING:
#> files <- c('session1.vtt', 'session2.vtt')
#> results <- batch_basic_analysis(files, 'output/')
#>
#> NEED HELP?
#> - show_available_functions() - See functions at your level
#> - show_function_help('function_name') - Get help for specific function
#> - find_function_for_task('what you want to do') - Find the right function
#> - set_ux_level('intermediate') - Show more functions
#>
#> PRIVACY & ETHICS:
#> - Privacy protection is enabled by default
#> - Use ensure_privacy() to protect sensitive data
#> - See review_privacy_risks() for privacy review
#>
#> MORE RESOURCES:
#> - vignette('getting-started') - Detailed tutorial
#> - utils::help(package = 'engager') - All documentation