Skip to contents

Show workflow help and templates

Usage

show_workflow_help()

Value

Invisibly NULL; called for its formatted console guide.

Examples

show_workflow_help()
#> 
#> Available Workflows
#> =====================
#> 
#> Basic Workflow (Recommended for new users):
#>    results <- basic_transcript_analysis('file.vtt')
#>    # Supply output_dir explicitly when files should be written.
#> 
#> QUICK: Quick Workflow (Fastest):
#>    results <- quick_analysis('file.vtt')
#> 
#> RESULTS: Step-by-Step Workflow (Full control):
#>    1. transcript <- load_zoom_transcript('file.vtt')
#>    2. processed <- process_zoom_transcript(transcript_df = transcript)
#>    3. analysis <- summarize_transcript_metrics(transcript_df = processed)
#>    4. plots <- plot_users(analysis, metric = 'wordcount', facet_by = 'transcript_file')
#>    5. write_metrics(analysis, path = 'output/engagement_metrics.csv')
#> 
#> Batch Workflow (Multiple files):
#>    files <- c('session1.vtt', 'session2.vtt', 'session3.vtt')
#>    results <- batch_basic_analysis(files)
#>    # Supply output_dir explicitly when files should be written.
#> 
#> Advanced Workflows:
#>    - Use set_ux_level('intermediate') to see more options
#>    - Use set_ux_level('advanced') for specialized functions
#>    - Use set_ux_level('expert') for all functions
#> 
#> TIP: Need help finding the right workflow?
#>    find_function_for_task('what you want to do')