diff --git a/NAMESPACE b/NAMESPACE index 6ae9268..4da5284 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,2 +1,3 @@ # Generated by roxygen2: do not edit by hand +export(status_check) diff --git a/R/status_check.R b/R/status_check.R index 33603c6..af16b45 100644 --- a/R/status_check.R +++ b/R/status_check.R @@ -1,3 +1,18 @@ +#' Check that all DAWA services are operational +#' +#' @param return_df This option makes the function return a dataframe object +#' with the services and their statuses listed +#' @param error_if_unavailable This option forces the function to throw an error +#' in the event that one or more services are unreachable. +#' +#' @return Returns a data frame object with the services and their statuses. Is +#' only returned if `return_df = TRUE` +#' @export +#' +#' @examples +#' +#' status_check() +#' status_check <- function(return_df = FALSE, error_if_unavailable = FALSE) { status_url <- "https://erdataforsyningennede.site24x7statusiq.com/rss" diff --git a/man/status_check.Rd b/man/status_check.Rd new file mode 100644 index 0000000..45fef6f --- /dev/null +++ b/man/status_check.Rd @@ -0,0 +1,27 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/status_check.R +\name{status_check} +\alias{status_check} +\title{Check that all DAWA services are operational} +\usage{ +status_check(return_df = FALSE, error_if_unavailable = FALSE) +} +\arguments{ +\item{return_df}{This option makes the function return a dataframe object +with the services and their statuses listed} + +\item{error_if_unavailable}{This option forces the function to throw an error +in the event that one or more services are unreachable.} +} +\value{ +Returns a data frame object with the services and their statuses. Is +only returned if \code{return_df = TRUE} +} +\description{ +Check that all DAWA services are operational +} +\examples{ + +status_check() + +}