Create summary reports of receiver project data from the OTN data push

Usage

make_receiver_push_summary(
  matos_project = NULL,
  qualified = NULL,
  unqualified = NULL,
  update_push_log = FALSE,
  deployment = NULL,
  out_dir = getwd(),
  since = NULL,
  rmd = FALSE
)

Arguments

matos_project: MATOS project number or name that you wish to have summarized
qualified, unqualified: Default is NULL: OTN qualified or unqualified detections will be downloaded from MATOS and unzipped. If you do not wish to download your files (or you're not a member of ACT), this argument also accepts a character vector of file paths of your qualified/unqualified detections. These can be CSVs or zipped folders.
update_push_log: Do you wish to use an updated push log? Default is FALSE, but switch to TRUE if you haven't updated this package since the push occurred.
deployment: File path of user-supplied master OTN receiver deployment metadata.
out_dir: Defaults to working directory. In which directory would you like to save the report?
since: Date in YYYY-MM-DD format. If you're an ACT-ite, this is mostly covered by the embedded ACT push log.
rmd: Logical. Compile via RMarkdown rather than Quarto?

Push log

To keep track of when ACT data pushes occur, a log is kept on the package's GitHub page. This is automatically downloaded every time you download or update the package, but you can avoid re-downloading the package by changing update_push_log to TRUE.

If you're not an ACTee, you can get similar behavior by providing a date to the since argument.

No files provided

If you only provide your ACT project number or title and leave all of the arguments as their defaults, this function will ask you to log in then proceed to download all of the necessary files. If you provide already-downloaded files you can speed up this process substantially.

Output

This function creates an HTML report that can be viewed in your web browser.

Examples

if (FALSE) {
# Using only the ACT/MATOS project number:
make_receiver_push_summary(87)

# Providing a local file:
make_receiver_push_summary(87, deployment = "my_master_deployment_metadata.xlsx")
}