validate_inputs_ctm: Validate Inputs for Type Metrics Calculation

View source: R/calc_type_metrics.R

validate_inputs_ctmR Documentation

Validate Inputs for Type Metrics Calculation

Description

Helper function that validates the input parameters for the calc_type_metrics function. Checks data frame structure, column existence, and metric specifications.

Usage

validate_inputs_ctm(data, type, document, frequency, dispersion)

Arguments

data

A data frame to validate

type

Column name for the type/term variable

document

Column name for the document ID variable

frequency

Character vector of requested frequency metrics

dispersion

Character vector of requested dispersion metrics

Details

Stops execution with error message if:

  • data is not a data frame

  • required columns are missing

  • frequency contains invalid metric names

  • dispersion contains invalid metric names

Value

No return value, called for side effects


qtkit documentation built on April 4, 2025, 4:47 a.m.