The idea of the release calendar is to set a release date for some time series that might be in the database already but should not be publicly available before a specific date, e.g., a press release. Since publishing is simply a matter of changing the access level, an update of the access levels could be triggered based on the release information in a release table. Only timeseries admins may create and modify releases.
db_release_create(
con,
id,
title,
release_date,
datasets,
target_year = year(release_date),
target_period = month(release_date),
target_frequency = 12,
note = NULL,
schema = "timeseries"
)RPostgres connection object.
Identifier for the release e.g. 'gdb_may_2020'
Display title for the release
Timestamp when the release is to occur
character vector of the datasets. Dataset is a group of time series.
Year observed in the data
Period observed in the data (e.g. month, quarter)
Frequency of the data (e.g. 4 for quarterly)
Additional remarks about the release.
character name of the database schema. Defaults to 'timeseries'
a status list
target_period changes meaning depending on the frequency of the release.
e.g. period 2 for quarterly data (reference_frequency = 4) means Q2 whereas
period 2 for monthly data (frequency 12) means February
In other words: target_year and target_period mark the end of the time series
in the release.
Other calendar functions:
db_dataset_get_latest_release(),
db_dataset_get_next_release(),
db_dataset_get_release(),
db_release_cancel(),
db_release_list(),
db_release_update()