Generating automated reports based on a camReport object

These functions facilitate generating two reports (data quality status, and ecological insights) automatically. Each report is an HTML rendered by creating an RMarkdown file based on the modules added to the camReport object.

Usage

report(object,filename,view, test)

status(object,filename,view)

Arguments

object: The camReport object created by the camData function
filename: optional (default is "report"); a character specifying filename or path/filename to write the report and rmarkdown files. The default location to write the files is the data folder
view: logical (default = TRUE); specifies whether the renderred html file should be displayed!
test: logical (default = FALSE); specifies whether the sections should be tested!

Details

By default (if filename is not specified), two files including "report.html" and "report.rmd" ("data_status.html" and "data_status.rmd" for the data status report) will be written in the folder of the camera-trap dataset.

If `test = TRUE` is used, in case any error is caused in the report generation procedure, a testing procedure is started to test each section and exclude the problematic section.

References

Ebrahimi et al. (2025) xxx

Author

Elham Ebrahimi

Examples



if (FALSE) { # \dontrun{
cm <- camData("data-folder")

report(cm, view=T) # ecological insights

status(cm, view=T) #  data quality status



} # }