Skip to contents

Show help for specific function

Usage

show_function_help(function_name)

Arguments

function_name

Name of function to get help for

Value

Invisibly NULL; called for its formatted console help.

Examples

show_function_help("load_zoom_transcript")
#> RESULTS: Common Function:  load_zoom_transcript 
#> ====================================== 
#> Description:  Load transcript from file 
#> 
#> DOCS: Documentation:
show_function_help("basic_transcript_analysis")
#> Essential Function:  basic_transcript_analysis 
#> ============================================= 
#> Description:  Complete analysis workflow for new users 
#> 
#> DOCS: Documentation:
#> 
#> TIP: Usage Examples:
#>    results <- basic_transcript_analysis('transcript.vtt')
#>    results <- basic_transcript_analysis('transcript.vtt', 'output/', 'medium')