rate_entities: Rate child or entity records

View source: R/entities.R

rate_entitiesR Documentation

Rate child or entity records

Description

Apply a rating plan to entity-level records such as drivers, vehicles, boats, or scheduled items, returning both rated values and trace output.

Usage

rate_entities(entity_data, plan, validate = TRUE)

Arguments

entity_data

A data frame containing one row per entity to be rated.

plan

A rating_plan object created by new_rating_plan().

validate

Logical. If TRUE, validate the entity data before rating.

Value

A rating_result object containing rated_data, term_trace, and the rating plan.

Examples

ex <- example_rating_plan()

drivers <- ex$policies
drivers$household_id <- "H1"
drivers$policy_id <- c("D1", "D2")

result <- rate_entities(
  entity_data = drivers,
  plan = ex$plan
)

result$rated_data
result$term_trace

ratingtables documentation built on Sept. 6, 2026, 1:06 a.m.