get_theme_status: Check Theme Status

View source: R/get_theme_status.R

get_theme_statusR Documentation

Check Theme Status

Description

This function is a wrapper for the Check Theme Status API. It returns a named logical indicating if the theme is updated at a specific date.

Usage

get_theme_status(
  token,
  theme,
  date = Sys.Date(),
  time = format(Sys.time(), format = "%T")
)

Arguments

token

User's API token. This can be retrieved using get_token

theme

Query name of theme. Themes’ query names can be retrieved using search_themes.

date

Default = current date. Date to check for updates. Format YYYY-MM-DD

time

Default = current time. Time to check for updates. Format: HH:MM:SS:FFFZ

Value

A named logical indicating if the theme is updated at a specific date. If an error occurred, the function returns NULL along with a warning message.

Examples

# returns named logical
## Not run: get_theme_status(token, "kindergartens")
## Not run: get_theme_status(token, "hotels", "2020-01-01", "12:00:00")

# returns NULL, warning message shows status code
## Not run: get_theme_status("invalid_token", "blood_bank")

# returns NULL, warning message shows error
## Not run: get_theme_status(token, "invalid_theme")

onemapsgapi documentation built on Nov. 29, 2022, 9:06 a.m.