---
title: "Data Status Report"
author: "Elham Ebrahimi"
description: "This vignette describes the Data Status Report and explains the checks used to assess the quality, completeness, and consistency of camera-trap data."
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Data Status Report}
%\VignetteEngine{knitr::rmarkdown}
\usepackage[utf8]{inputenc}
---
## Data Status Report
The Data Status Report provides an overview of the quality, completeness, and readiness of a camera-trap dataset before generating the final Ecological Report. It helps users check whether the main input files, metadata fields, deployment information, observation records, taxonomy, timestamps, annotation information, and spatial data are complete and internally consistent.
This report is especially useful as a first quality-control step. It allows users to identify missing values, duplicated records, invalid timestamps, incomplete metadata, spatial issues, and inconsistencies between deployments and observations. Based on these checks, users can decide whether the dataset is ready for reporting or whether further correction is needed before ecological analyses are performed.
```{r data-status-workflow, echo=FALSE, out.width="100%", fig.cap="Figure 1. Workflow for generating a Data Status Report from camera-trap data using camtrapReport."}
knitr::include_graphics("figures/data-status/WF_DS.png")
```
Figure 1 summarises how `camtrapReport` checks the readiness of a camera-trap dataset before ecological reporting. After the data are loaded with `camData()`, the `status()` function runs automated checks on the main input files, metadata, deployments, observations, timestamps, taxonomy, spatial information, and annotation records. The output helps users identify potential issues and decide whether the dataset is ready for generating the final Ecological Report.
```{r data-status-basic-code, eval=FALSE}
library(camtrapReport)
# Load camera-trap data
cm <- camData("cameratrap.zip")
# Generate and view the Data Status Report
status(cm, view = TRUE)
```
When `view = TRUE`, the generated report is opened in the browser. This provides a quick, human-readable overview of dataset quality, completeness, and consistency.
## Example Data Status Reports
Below are example Data Status Reports generated with `camtrapReport` for different camera-trap monitoring projects. These examples show how the report can be used to assess dataset completeness, detect possible issues, and evaluate whether the data are ready for ecological reporting. Click on an image to open the full HTML report.
## Exploring data-status results in R
The results of the data-status checks are also stored inside the `camReport` object. Users can explore these results directly in R through the `data_status` slot. This is useful when users want to inspect the underlying tables, extract summaries, or use the quality-control outputs in another workflow.
```{r data-status-explore-object, eval=FALSE}
# Explore all data-status outputs stored in the camReport object
cm$data_status
# Show the available data-status components
names(cm$data_status)
cm$data_status$Spatial
cm$data_status$Temporal
cm$data_status$Essentials
cm$data_status$Annotation
cm$data_status$Validation
cm$data_status$Species
cm$data_status$Visuals
```
For example, the species table can be inspected to check which species were detected and how many captures were recorded for each species.
```{r data-status-species-table, eval=FALSE}
# View species summary table
cm$data_status$Species$Table
```
Together, `status(cm, view = TRUE)` and `cm$data_status` provide both a human-readable HTML report and direct access to the underlying data-quality summaries in R. This makes the Data Status Report useful for documenting data readiness, identifying issues, and improving the dataset before generating the final Ecological Report.
