vivainsights.check_inputs¶

Validate that required variables exist in a DataFrame.

vivainsights.check_inputs.check_inputs(data, requirements)[source]¶

Check that each variable in requirements exists as a column in data.

Parameters:

data (pandas.DataFrame) – DataFrame to validate.
requirements (list of str) – Column names that must be present in data.

Raises:

ValueError – If any required variable is missing from data.

Examples

Check that required columns are present (no error if all exist):

>>> import vivainsights as vi
>>> pq_data = vi.load_pq_data()
>>> vi.check_inputs(pq_data, ["PersonId", "MetricDate"])

This will raise a ValueError if a column is missing:

>>> vi.check_inputs(pq_data, ["PersonId", "NonExistentColumn"])  