Class SentenceAnalyzer

Index

Constructors

constructor

Methods

analyzeSentence analyzeSentences calculateStatistics

Constructors

constructor

new SentenceAnalyzer(): SentenceAnalyzer
Returns SentenceAnalyzer

Methods

analyzeSentence

analyzeSentence(metrics: MetricsResult, words: string[]): SentenceAnalysis
Analyze effort to construct a single sentence
Parameters
- metrics: MetricsResult
- words: string[]
Returns SentenceAnalysis
- Defined in src/utilities/analytics/metrics/sentence.ts:32

analyzeSentences

analyzeSentences(
metrics: MetricsResult,
sentences: string[][],
): SentenceAnalysis[]
Analyze effort to construct a set of test sentences
Parameters
- metrics: MetricsResult
- sentences: string[][]
Returns SentenceAnalysis[]
- Defined in src/utilities/analytics/metrics/sentence.ts:25

calculateStatistics

calculateStatistics(
    analyses: SentenceAnalysis[],
): {
    average_effort: number;
    max_effort: number;
    median_effort: number;
    min_effort: number;
    sentences_requiring_typing: number;
    sentences_without_typing: number;
    total_sentences: number;
    total_words: number;
    typing_percent: number;
    words_requiring_typing: number;
}
Calculate statistics across all sentences
Parameters
- analyses: SentenceAnalysis[]
Returns {
    average_effort: number;
    max_effort: number;
    median_effort: number;
    min_effort: number;
    sentences_requiring_typing: number;
    sentences_without_typing: number;
    total_sentences: number;
    total_words: number;
    typing_percent: number;
    words_requiring_typing: number;
}
- Defined in src/utilities/analytics/metrics/sentence.ts:99

Class SentenceAnalyzer

Index

Constructors

Methods

Constructors

constructor

Returns SentenceAnalyzer

Methods

analyzeSentence

Parameters

Returns SentenceAnalysis

analyzeSentences

Parameters

Returns SentenceAnalysis[]

calculateStatistics

Parameters

Settings

On This Page

Class SentenceAnalyzer

Index

Constructors

Methods

Constructors

constructor

Returns SentenceAnalyzer

Methods

analyzeSentence

Parameters

Returns SentenceAnalysis

analyzeSentences

Parameters

Returns SentenceAnalysis[]

calculateStatistics

Parameters

Returns { average_effort: number; max_effort: number; median_effort: number; min_effort: number; sentences_requiring_typing: number; sentences_without_typing: number; total_sentences: number; total_words: number; typing_percent: number; words_requiring_typing: number;}

Settings

On This Page

Returns {
average_effort: number;
max_effort: number;
median_effort: number;
min_effort: number;
sentences_requiring_typing: number;
sentences_without_typing: number;
total_sentences: number;
total_words: number;
typing_percent: number;
words_requiring_typing: number;
}