Create summary reports of receiver project data from the OTN data push.
Source:R/receiver_summary.R
otn_receiver_summary.RdCreate summary reports of receiver project data from the OTN data push.
Usage
otn_receiver_summary(
project = NULL,
qualified = NULL,
unqualified = NULL,
deployment = NULL,
...
)Arguments
- project
Character. The project code.
- qualified, unqualified
Default is NULL: OTN qualified or unqualified detections in parquet format will be downloaded from the data server. This argument also accepts a character vector of file paths of your qualified/unqualified detections if you do not wish to download your files or your node does not use an OTN-style Plone CMS.
- deployment
File path of user-supplied master OTN receiver deployment metadata.
- ...
Arguments passed to
otndo::make_receiver_push_summary
No files provided
If you only provide your project code 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. You can speed up this process substantially by providing already-downloaded files.
Examples
if (FALSE) { # \dontrun{
# Using only the project code:
otn_receiver_summary("tailwinds")
# Providing a local file:
otn_receiver_summary("tailwinds", deployment = "my_master_deployment_metadata.xlsx")
# Get a summary fo what has changed since a particular date:
otn_receiver_summary("tailwinds", since = "2022-05-01")
} # }