validate_inputs_cam: Validate Inputs for Association Metrics Calculation

View source: R/calc_assoc_metrics.R

validate_inputs_camR Documentation

Validate Inputs for Association Metrics Calculation

Description

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

Usage

validate_inputs_cam(data, doc_index, token_index, type, association)

Arguments

data

A data frame to validate

doc_index

Column name for document index

token_index

Column name for token position

type

Column name for the tokens/terms

association

Character vector of requested association metrics

Details

Stops execution with error message if:

  • data is not a data frame

  • required columns are missing

  • association contains invalid metric names

Value

No return value, called for side effects


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