Answers two different questions depending on live. With live = FALSE it
reports what the package knows about each source without contacting anything.
With live = TRUE it asks each verified source to answer a small request and
reports what happened.
Usage
knbs_status(source = NULL, live = interactive(), timeout = 10)Arguments
- source
Source ids to check. Defaults to every registered source.
- live
Whether to contact the sources. Defaults to
interactive(), so that automated runs never depend on a live service.- timeout
Request timeout in seconds, applied only to this call.
Value
A tibble with one row per source and columns
source_id, operation, status, http_status, response_time_ms,
checked_at and message.
Details
The status column is one of:
okThe source answered.
unavailableThe source was contacted and did not answer usefully. The
messagecolumn says why.unverifiedThe source's endpoint has not been verified, so there is nothing to contact. It is never checked live.
not_checkedThe source could have been checked, but
livewasFALSE.
See also
knbs_sources() for what each source supports.
Examples
# Offline: reports what the registry knows, contacts nothing.
knbs_status(live = FALSE)
#> # A tibble: 9 × 7
#> source_id operation status http_status response_time_ms checked_at
#> <chr> <chr> <chr> <int> <dbl> <dttm>
#> 1 kenada search_s… not_c… NA NA 2026-10-21 18:30:25
#> 2 finaccess download… not_c… NA NA 2026-10-21 18:30:25
#> 3 knbs_public… search_p… not_c… NA NA 2026-10-21 18:30:25
#> 4 knbs_indica… list_ind… not_c… NA NA 2026-10-21 18:30:25
#> 5 knbs_cpi list_ind… not_c… NA NA 2026-10-21 18:30:25
#> 6 knbs_openda… list_ind… not_c… NA NA 2026-10-21 18:30:25
#> 7 opendatafor… list_ind… not_c… NA NA 2026-10-21 18:30:25
#> 8 dhs_program list_ind… not_c… NA NA 2026-10-21 18:30:25
#> 9 fake_source search_s… unver… NA NA 2026-10-21 18:30:25
#> # ℹ 1 more variable: message <chr>
if (FALSE) { # interactive()
# Contacts each verified source.
knbs_status(live = TRUE)
}