57 task write trails drawing feature functions percent accurate paths (#92)

* percent_accurate_paths

* unit tests

* fix docstring, change variable name

Author: cgmaiorano

src/graphomotor/features/trails/drawing_metrics.py

@@ -29,3 +29,27 @@ def get_total_errors(drawing: models.Drawing) -> dict[str, float]:
             "Drawing data does not contain 'total_number_of_errors' column."
         )
     return {"total_errors": drawing.data["total_number_of_errors"].iloc[0]}
+
+
+def percent_accurate_paths(drawing: models.Drawing) -> dict[str, float]:
+    """Calculate the percentage of accurate paths in a trails drawing task.
+
+    Args:
+        drawing: Drawing object containing drawing data.
+
+    Returns:
+        Dictionary containing the percentage of accurate paths of the task.
+
+    Raises:
+        ValueError: If required columns are missing in the drawing data.
+    """
+    if not {"correct_path", "actual_path"}.issubset(drawing.data.columns):
+        raise ValueError(
+            "DataFrame must contain 'correct_path' and 'actual_path' columns."
+        )
+
+    return {
+        "percent_accurate_paths": (
+            (drawing.data["correct_path"] == drawing.data["actual_path"]).mean() * 100
+        )
+    }

tests/unit/test_trails_drawing_metrics.py

@@ -45,3 +45,26 @@ def test_valid_total_errors() -> None:
 
     result = drawing_metrics.get_total_errors(drawing)
     assert result == {"total_errors": 1.0}
+
+
+def test_percent_accurate_paths_missing_columns() -> None:
+    """Test ValueError when required columns are missing."""
+    invalid_df = pd.DataFrame({"some_other_column": [0, 1, 2]})
+    drawing = models.Drawing(
+        data=invalid_df, task_name="trails", metadata={"id": "5555555"}
+    )
+
+    with pytest.raises(
+        ValueError,
+        match="DataFrame must contain 'correct_path' and 'actual_path' columns.",
+    ):
+        drawing_metrics.percent_accurate_paths(drawing)
+
+
+def test_percent_accurate_paths_sample_data() -> None:
+    """Test percent_accurate_paths with sample drawing data."""
+    filepath = "tests/sample_data/[5000000]648b6b868819c1120b4f6ce3-trail4.csv"
+    drawing = reader.load_drawing_data(filepath)
+
+    result = drawing_metrics.percent_accurate_paths(drawing)
+    assert result == {"percent_accurate_paths": 100.0}