diff --git a/R/collections.R b/R/collections.R index 0795fe9..ea50ba0 100644 --- a/R/collections.R +++ b/R/collections.R @@ -87,7 +87,8 @@ read_collection_ts <- function( data <- jsonlite::fromJSON(httr2::resp_body_string(res), simplifyDataFrame = F) names(data) <- purrr::map_chr(data, "ts_key") - lapply(data, json_to_ts) + # lapply(data, json_to_ts) + return(data) } #' Read collection time series metadata diff --git a/R/datasets.R b/R/datasets.R index 8c84322..6569e93 100644 --- a/R/datasets.R +++ b/R/datasets.R @@ -141,7 +141,7 @@ read_dataset_ts_history <- function( httr2::req_perform() data <- jsonlite::fromJSON(httr2::resp_body_string(res), simplifyDataFrame = F) - names(data) <- purrr::map_chr(data, ~paste0(.x$ts_key, "_", .x$validity)) + names(data) <- purrr::map_chr(data, ~paste0(.x$ts_key, "_", .x$vintage_date)) lapply(data, json_to_ts) } diff --git a/R/param_docs.R b/R/param_docs.R index 2085a7e..818358a 100644 --- a/R/param_docs.R +++ b/R/param_docs.R @@ -27,5 +27,6 @@ #' @param overwrite If TRUE, the existing metadata is replaced completely. If FALSE (default), new fields are added and existing fields are updated. #' @param skip_check If FALSE (default), the user must manually confirm the deletion of time series. #' @param subscription_start_date Start date of the user subscription +#' @param vintage_date character string containing a YYYY-MM-DD formatted date to indicate the date that this particular vintage refers to. #' @name param_defs NULL diff --git a/R/time_series.R b/R/time_series.R index ae082e0..cc86ba3 100644 --- a/R/time_series.R +++ b/R/time_series.R @@ -62,7 +62,7 @@ read_ts_history <- function( httr2::req_perform() data <- jsonlite::fromJSON(httr2::resp_body_string(res), simplifyDataFrame = F) - names(data) <- purrr::map_chr(data, ~paste0(.x$ts_key, "_", stringr::str_replace_all(.x$validity, "-", ""))) + names(data) <- purrr::map_chr(data, ~paste0(.x$ts_key, "_", stringr::str_replace_all(.x$vintage_date, "-", ""))) lapply(data, json_to_ts) } diff --git a/R/utils.R b/R/utils.R index 882bbbd..12d5f45 100644 --- a/R/utils.R +++ b/R/utils.R @@ -170,8 +170,9 @@ to_bool_query_param <- function(arg) { } json_to_ts <- function(data) { - res <- xts::xts(data$value, order.by = as.Date(data$time), frequency = data$frequency) - if(data$frequency) { + freq <- data$frequency + res <- xts::xts(data$value, order.by = as.Date(data$time), frequency = freq) + if (!is.null(freq) && isTRUE(freq > 0)) { tsbox::ts_ts(res) } else { res diff --git a/man/add_ts_to_access_set.Rd b/man/add_ts_to_access_set.Rd new file mode 100644 index 0000000..7d8f20d --- /dev/null +++ b/man/add_ts_to_access_set.Rd @@ -0,0 +1,27 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/access_sets.R +\name{add_ts_to_access_set} +\alias{add_ts_to_access_set} +\title{Add time series to access set} +\usage{ +add_ts_to_access_set(access_set, ts_keys, ignore_missing = F) +} +\arguments{ +\item{access_set}{Name of the access set. An access set is a group of time series for which a permission (read_quota, read, read_before_release, write) can be granted to individual users. Every time series can be a member of multiple access sets.} + +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\description{ +Adds existing time series (given by their keys) to a time series access set. +} +\seealso{ +Other access set functions: +\code{\link{create_access_set}()}, +\code{\link{delete_access_set}()}, +\code{\link{list_access_sets}()}, +\code{\link{read_access_set_keys}()}, +\code{\link{remove_ts_from_access_set}()} +} +\concept{access set functions} diff --git a/man/add_ts_to_collection.Rd b/man/add_ts_to_collection.Rd new file mode 100644 index 0000000..783d4d0 --- /dev/null +++ b/man/add_ts_to_collection.Rd @@ -0,0 +1,36 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{add_ts_to_collection} +\alias{add_ts_to_collection} +\title{Add time series to collection} +\usage{ +add_ts_to_collection(collection, owner = "self", ts_keys, ignore_missing = F) +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} + +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\description{ +Adds existing time series (given by their keys) to a time series collection. +} +\seealso{ +Other time series collection functions: +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/add_user_access_sets.Rd b/man/add_user_access_sets.Rd new file mode 100644 index 0000000..29661e0 --- /dev/null +++ b/man/add_user_access_sets.Rd @@ -0,0 +1,29 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/users.R +\name{add_user_access_sets} +\alias{add_user_access_sets} +\title{Add user access sets} +\usage{ +add_user_access_sets(username = "self", access_sets, permission) +} +\arguments{ +\item{username}{Username of the time series database user} + +\item{access_sets}{Names of the access sets. An access set is a group of time series for which a permission (one of read_quota, read, read_before_release or write) can be granted to users. A time series can be a member of multiple access sets.} + +\item{permission}{The permission granted to the user for the time series in the access set. Must be one of read_quota, read, read_before_release or write.} +} +\description{ +Add access sets for a user with a given permission. +} +\seealso{ +Other user management functions: +\code{\link{create_user_api_key}()}, +\code{\link{create_user_quota}()}, +\code{\link{delete_user_quota}()}, +\code{\link{list_user_access_sets}()}, +\code{\link{list_users}()}, +\code{\link{remove_user_access_sets}()}, +\code{\link{write_user_quota}()} +} +\concept{user management functions} diff --git a/man/create_access_set.Rd b/man/create_access_set.Rd new file mode 100644 index 0000000..fc1edb0 --- /dev/null +++ b/man/create_access_set.Rd @@ -0,0 +1,25 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/access_sets.R +\name{create_access_set} +\alias{create_access_set} +\title{Create access set} +\usage{ +create_access_set(access_set, description) +} +\arguments{ +\item{access_set}{Name of the access set. An access set is a group of time series for which a permission (read_quota, read, read_before_release, write) can be granted to individual users. Every time series can be a member of multiple access sets.} + +\item{description}{Description of the access set} +} +\description{ +Create a new time series access set. +} +\seealso{ +Other access set functions: +\code{\link{add_ts_to_access_set}()}, +\code{\link{delete_access_set}()}, +\code{\link{list_access_sets}()}, +\code{\link{read_access_set_keys}()}, +\code{\link{remove_ts_from_access_set}()} +} +\concept{access set functions} diff --git a/man/create_collection.Rd b/man/create_collection.Rd new file mode 100644 index 0000000..b67d6a0 --- /dev/null +++ b/man/create_collection.Rd @@ -0,0 +1,35 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{create_collection} +\alias{create_collection} +\title{Create time series collection} +\usage{ +create_collection(collection, owner = "self", description) +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} + +\item{description}{Description of the time series collection} +} +\description{ +Create a new time series collection. By default, the created collection is owned by the authenticated user. +To create a collection for another user, provide the username of that user as the owner parameter. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/create_dataset.Rd b/man/create_dataset.Rd new file mode 100644 index 0000000..649a256 --- /dev/null +++ b/man/create_dataset.Rd @@ -0,0 +1,31 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{create_dataset} +\alias{create_dataset} +\title{Create a dataset} +\usage{ +create_dataset(dataset, description) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{description}{Description of the dataset.} +} +\description{ +Create a time series dataset. Every time series can belong to only one dataset. +} +\seealso{ +Other dataset functions: +\code{\link{delete_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{read_dataset_ts_write_time}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/create_user.Rd b/man/create_user.Rd new file mode 100644 index 0000000..014c662 --- /dev/null +++ b/man/create_user.Rd @@ -0,0 +1,16 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/users.R +\name{create_user} +\alias{create_user} +\title{Create user} +\usage{ +create_user(username, role) +} +\arguments{ +\item{username}{Username of the time series database user} + +\item{role}{Role of the user. Must be one of 'admin', 'intern' or 'extern'.} +} +\description{ +Create a time series database user with a given role. +} diff --git a/man/create_user_api_key.Rd b/man/create_user_api_key.Rd new file mode 100644 index 0000000..867b65f --- /dev/null +++ b/man/create_user_api_key.Rd @@ -0,0 +1,30 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/users.R +\name{create_user_api_key} +\alias{create_user_api_key} +\title{Create user API key} +\usage{ +create_user_api_key(username = "self") +} +\arguments{ +\item{username}{Username of the time series database user} +} +\value{ +List with API key. +} +\description{ +Create an API key for a user for programmatic access. +Any previously created API key for the user will be overwritten and therefore invalidated. +Store the newly created API key securely because it cannot be retrieved later. +} +\seealso{ +Other user management functions: +\code{\link{add_user_access_sets}()}, +\code{\link{create_user_quota}()}, +\code{\link{delete_user_quota}()}, +\code{\link{list_user_access_sets}()}, +\code{\link{list_users}()}, +\code{\link{remove_user_access_sets}()}, +\code{\link{write_user_quota}()} +} +\concept{user management functions} diff --git a/man/create_user_quota.Rd b/man/create_user_quota.Rd new file mode 100644 index 0000000..6fc4778 --- /dev/null +++ b/man/create_user_quota.Rd @@ -0,0 +1,29 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/users.R +\name{create_user_quota} +\alias{create_user_quota} +\title{Create user quota} +\usage{ +create_user_quota(username, subscription_annual_quota, subscription_start_date) +} +\arguments{ +\item{username}{Username of the time series database user} + +\item{subscription_annual_quota}{Annual download quota of data service subscription} + +\item{subscription_start_date}{Start date of the user subscription} +} +\description{ +Create an annual quota for a data service subscriber. Without a quota, the user has an unlimited number of time series downloads. +} +\seealso{ +Other user management functions: +\code{\link{add_user_access_sets}()}, +\code{\link{create_user_api_key}()}, +\code{\link{delete_user_quota}()}, +\code{\link{list_user_access_sets}()}, +\code{\link{list_users}()}, +\code{\link{remove_user_access_sets}()}, +\code{\link{write_user_quota}()} +} +\concept{user management functions} diff --git a/man/delete_access_set.Rd b/man/delete_access_set.Rd new file mode 100644 index 0000000..dcd642f --- /dev/null +++ b/man/delete_access_set.Rd @@ -0,0 +1,23 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/access_sets.R +\name{delete_access_set} +\alias{delete_access_set} +\title{Delete access set} +\usage{ +delete_access_set(access_set) +} +\arguments{ +\item{access_set}{Name of the access set. An access set is a group of time series for which a permission (read_quota, read, read_before_release, write) can be granted to individual users. Every time series can be a member of multiple access sets.} +} +\description{ +Delete an existing time series access set. Permissions granted to the access set will also be removed. +} +\seealso{ +Other access set functions: +\code{\link{add_ts_to_access_set}()}, +\code{\link{create_access_set}()}, +\code{\link{list_access_sets}()}, +\code{\link{read_access_set_keys}()}, +\code{\link{remove_ts_from_access_set}()} +} +\concept{access set functions} diff --git a/man/delete_collection.Rd b/man/delete_collection.Rd new file mode 100644 index 0000000..1f71b65 --- /dev/null +++ b/man/delete_collection.Rd @@ -0,0 +1,32 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{delete_collection} +\alias{delete_collection} +\title{Delete time series collection} +\usage{ +delete_collection(collection, owner = "self") +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} +} +\description{ +Permanently delete an existing time series collection. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/delete_dataset.Rd b/man/delete_dataset.Rd new file mode 100644 index 0000000..7b49b18 --- /dev/null +++ b/man/delete_dataset.Rd @@ -0,0 +1,31 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{delete_dataset} +\alias{delete_dataset} +\title{Delete dataset} +\usage{ +delete_dataset(dataset, skip_check = F) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{skip_check}{If FALSE (default), the user must manually confirm the deletion of time series.} +} +\description{ +Permanently delete all time series in a dataset, including all vintages and metadata, and the dataset itself. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{read_dataset_ts_write_time}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/delete_ts.Rd b/man/delete_ts.Rd new file mode 100644 index 0000000..d3eb95f --- /dev/null +++ b/man/delete_ts.Rd @@ -0,0 +1,36 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{delete_ts} +\alias{delete_ts} +\title{Delete time series} +\usage{ +delete_ts(ts_keys, ignore_missing = F, skip_check = F) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} + +\item{skip_check}{If FALSE (default), the user must manually confirm the deletion of time series.} +} +\description{ +Delete time series given by their unique identifiers (keys). The time series are removed completely, including all vintages and metadata. +} +\seealso{ +Other time series functions: +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/delete_user_quota.Rd b/man/delete_user_quota.Rd new file mode 100644 index 0000000..ca49dde --- /dev/null +++ b/man/delete_user_quota.Rd @@ -0,0 +1,26 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/users.R +\name{delete_user_quota} +\alias{delete_user_quota} +\title{Delete user quota} +\usage{ +delete_user_quota(username) +} +\arguments{ +\item{username}{Username of the time series database user} +} +\description{ +Delete the existing quota of a data service subscriber. +Without a quota, the user has an unlimited number of time series downloads. +} +\seealso{ +Other user management functions: +\code{\link{add_user_access_sets}()}, +\code{\link{create_user_api_key}()}, +\code{\link{create_user_quota}()}, +\code{\link{list_user_access_sets}()}, +\code{\link{list_users}()}, +\code{\link{remove_user_access_sets}()}, +\code{\link{write_user_quota}()} +} +\concept{user management functions} diff --git a/man/find_ts.Rd b/man/find_ts.Rd new file mode 100644 index 0000000..e97f136 --- /dev/null +++ b/man/find_ts.Rd @@ -0,0 +1,35 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{find_ts} +\alias{find_ts} +\title{Find time series} +\usage{ +find_ts(regexp) +} +\arguments{ +\item{regexp}{Regular expression pattern to search for time series keys.} +} +\value{ +Vector of time series keys matching the regular expression. +} +\description{ +Find time series keys by regular expression. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/get_config.Rd b/man/get_config.Rd new file mode 100644 index 0000000..ed509f3 --- /dev/null +++ b/man/get_config.Rd @@ -0,0 +1,19 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/utils.R +\name{get_config} +\alias{get_config} +\title{Get package configuration} +\usage{ +get_config() +} +\value{ +Named list of options. +} +\description{ +Get the package configuration options of the current session. Every option is initialized with the corresponding environment variables on package load. +} +\seealso{ +Other package configuration functions: +\code{\link{set_config}()} +} +\concept{package configuration functions} diff --git a/man/list_access_sets.Rd b/man/list_access_sets.Rd new file mode 100644 index 0000000..2080c99 --- /dev/null +++ b/man/list_access_sets.Rd @@ -0,0 +1,23 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/access_sets.R +\name{list_access_sets} +\alias{list_access_sets} +\title{List access sets} +\usage{ +list_access_sets() +} +\value{ +Table with a row for every existing access set. +} +\description{ +Read information on existing time series access sets. +} +\seealso{ +Other access set functions: +\code{\link{add_ts_to_access_set}()}, +\code{\link{create_access_set}()}, +\code{\link{delete_access_set}()}, +\code{\link{read_access_set_keys}()}, +\code{\link{remove_ts_from_access_set}()} +} +\concept{access set functions} diff --git a/man/list_collections.Rd b/man/list_collections.Rd new file mode 100644 index 0000000..f5e0f83 --- /dev/null +++ b/man/list_collections.Rd @@ -0,0 +1,35 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{list_collections} +\alias{list_collections} +\title{List time series collections} +\usage{ +list_collections(owner = "self") +} +\arguments{ +\item{owner}{Username of the owner of the time series collection} +} +\value{ +Table with a row for every existing collection. +} +\description{ +Read information on existing time series collections. +By default, the collections of the authenticated user are listed. +To list the collections of another user, provide the username of that user as the owner parameter. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/list_datasets.Rd b/man/list_datasets.Rd new file mode 100644 index 0000000..08160a8 --- /dev/null +++ b/man/list_datasets.Rd @@ -0,0 +1,29 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{list_datasets} +\alias{list_datasets} +\title{List datasets} +\usage{ +list_datasets() +} +\value{ +Table with a row for every existing dataset. +} +\description{ +Read information on existing time series datasets. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{delete_dataset}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{read_dataset_ts_write_time}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/list_user_access_sets.Rd b/man/list_user_access_sets.Rd new file mode 100644 index 0000000..53ef6a3 --- /dev/null +++ b/man/list_user_access_sets.Rd @@ -0,0 +1,28 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/users.R +\name{list_user_access_sets} +\alias{list_user_access_sets} +\title{List user access sets} +\usage{ +list_user_access_sets(username = "self") +} +\arguments{ +\item{username}{Username of the time series database user} +} +\value{ +Table with a row for every user access set. +} +\description{ +List the access sets and associated permissions of a particular user. +} +\seealso{ +Other user management functions: +\code{\link{add_user_access_sets}()}, +\code{\link{create_user_api_key}()}, +\code{\link{create_user_quota}()}, +\code{\link{delete_user_quota}()}, +\code{\link{list_users}()}, +\code{\link{remove_user_access_sets}()}, +\code{\link{write_user_quota}()} +} +\concept{user management functions} diff --git a/man/list_users.Rd b/man/list_users.Rd new file mode 100644 index 0000000..4760de9 --- /dev/null +++ b/man/list_users.Rd @@ -0,0 +1,25 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/users.R +\name{list_users} +\alias{list_users} +\title{List users} +\usage{ +list_users() +} +\value{ +Table with a row for every user. +} +\description{ +Show information on time series database users. +} +\seealso{ +Other user management functions: +\code{\link{add_user_access_sets}()}, +\code{\link{create_user_api_key}()}, +\code{\link{create_user_quota}()}, +\code{\link{delete_user_quota}()}, +\code{\link{list_user_access_sets}()}, +\code{\link{remove_user_access_sets}()}, +\code{\link{write_user_quota}()} +} +\concept{user management functions} diff --git a/man/param_defs.Rd b/man/param_defs.Rd new file mode 100644 index 0000000..3249b4d --- /dev/null +++ b/man/param_defs.Rd @@ -0,0 +1,63 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/param_docs.R +\name{param_defs} +\alias{param_defs} +\title{Common parameters} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{valid_from}{Start date of the vintage range} + +\item{valid_to}{End date of the vintage range} + +\item{ts_list}{Named list of time series of class, zoo or xts with time series keys as list names} + +\item{access}{The access level of the time series. This parameter is obsolete once the Time Series DB API v1 is discontinued.} + +\item{pre_release_access}{The access level of the time series before the time of release. This parameter is obsolete once the Time Series DB API v1 is discontinued.} + +\item{release_topic}{Topic of the release. For example 'kofbaro'.} + +\item{release_year}{Year of the release} + +\item{release_period}{Period of the release. For monthly releases a number from 1 to 12. For quarterly releases a number from 1 to 4. For half-yearly releases a number from 1 to 2. For yearly releases always 1.} + +\item{release_date}{Time of the release (POSIXct). This parameter is obsolete once the Time Series DB API v1 is discontinued.} + +\item{subscription_annual_quota}{Annual download quota of data service subscription} + +\item{current_year_quota}{Download quota of the current year. It is automatically set to subscription_annual_quota at the start of a subscription year.} + +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} + +\item{access_type}{One of 'auth' (the default), 'public' or 'preview'. The access types 'public' and 'preview' bypass authentication. Use the access type 'public' to read public time series and the access type 'preview' to read time series previews. Use 'auth' for authenticated access.} + +\item{locale}{The locale of the metadata. Can be any string, but ISO codes are recommended (such as 'en', 'de', 'fr', 'it'). Set to NULL for unlocalized metadata (default).} + +\item{owner}{Username of the owner of the time series collection} + +\item{collection}{Name of the time series collection} + +\item{username}{Username of the time series database user} + +\item{access_set}{Name of the access set. An access set is a group of time series for which a permission (read_quota, read, read_before_release, write) can be granted to individual users. Every time series can be a member of multiple access sets.} + +\item{access_sets}{Names of the access sets. An access set is a group of time series for which a permission (one of read_quota, read, read_before_release or write) can be granted to users. A time series can be a member of multiple access sets.} + +\item{permission}{The permission granted to the user for the time series in the access set. Must be one of read_quota, read, read_before_release or write.} + +\item{overwrite}{If TRUE, the existing metadata is replaced completely. If FALSE (default), new fields are added and existing fields are updated.} + +\item{skip_check}{If FALSE (default), the user must manually confirm the deletion of time series.} + +\item{subscription_start_date}{Start date of the user subscription} + +\item{vintage_date}{character string containing a YYYY-MM-DD formatted date to indicate the date that this particular vintage refers to.} +} +\description{ +Common parameters +} diff --git a/man/read_access_set_keys.Rd b/man/read_access_set_keys.Rd new file mode 100644 index 0000000..f81ec50 --- /dev/null +++ b/man/read_access_set_keys.Rd @@ -0,0 +1,26 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/access_sets.R +\name{read_access_set_keys} +\alias{read_access_set_keys} +\title{Read access set keys} +\usage{ +read_access_set_keys(access_set) +} +\arguments{ +\item{access_set}{Name of the access set. An access set is a group of time series for which a permission (read_quota, read, read_before_release, write) can be granted to individual users. Every time series can be a member of multiple access sets.} +} +\value{ +Character vector of time series keys +} +\description{ +Read the keys of the time series in a time series access set. +} +\seealso{ +Other access set functions: +\code{\link{add_ts_to_access_set}()}, +\code{\link{create_access_set}()}, +\code{\link{delete_access_set}()}, +\code{\link{list_access_sets}()}, +\code{\link{remove_ts_from_access_set}()} +} +\concept{access set functions} diff --git a/man/read_collection_keys.Rd b/man/read_collection_keys.Rd new file mode 100644 index 0000000..66f5e72 --- /dev/null +++ b/man/read_collection_keys.Rd @@ -0,0 +1,35 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{read_collection_keys} +\alias{read_collection_keys} +\title{Read collection time series keys} +\usage{ +read_collection_keys(collection, owner = "self") +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} +} +\value{ +Character vector of time series keys. +} +\description{ +Read the keys of the time series in a time series collection. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/read_collection_ts.Rd b/man/read_collection_ts.Rd new file mode 100644 index 0000000..05424d0 --- /dev/null +++ b/man/read_collection_ts.Rd @@ -0,0 +1,44 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{read_collection_ts} +\alias{read_collection_ts} +\title{Read collection time series} +\usage{ +read_collection_ts( + collection, + owner = "self", + valid_on = Sys.Date(), + ignore_missing = F +) +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +List of time series. Regular time series have the class ts and irregular time series the class xts. +} +\description{ +Read the time series in a time series collection. The time series vintage is specified by the valid_on parameter. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/read_collection_ts_history.Rd b/man/read_collection_ts_history.Rd new file mode 100644 index 0000000..103b63c --- /dev/null +++ b/man/read_collection_ts_history.Rd @@ -0,0 +1,49 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{read_collection_ts_history} +\alias{read_collection_ts_history} +\title{Read collection time series history} +\usage{ +read_collection_ts_history( + collection, + owner = "self", + valid_from = NULL, + valid_to = NULL, + ignore_missing = F +) +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} + +\item{valid_from}{Start date of the vintage range} + +\item{valid_to}{End date of the vintage range} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +List of time series. +Regular time series have the class ts and irregular time series the class xts. +The name of each time series is the time series key concatenated with the vintage date in format YYYYMMDD. +} +\description{ +Read multiple vintages of the time series in a collection. The vintage range is given by the valid_from and valid_to parameter. By default, the entire history is read. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/read_collection_ts_metadata.Rd b/man/read_collection_ts_metadata.Rd new file mode 100644 index 0000000..d239eb5 --- /dev/null +++ b/man/read_collection_ts_metadata.Rd @@ -0,0 +1,44 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{read_collection_ts_metadata} +\alias{read_collection_ts_metadata} +\title{Read collection time series metadata} +\usage{ +read_collection_ts_metadata( + collection, + owner = "self", + locale = NULL, + ignore_missing = F +) +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} + +\item{locale}{The locale of the metadata. Can be any string, but ISO codes are recommended (such as 'en', 'de', 'fr', 'it'). Set to NULL for unlocalized metadata (default).} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +List of time series metadata. Each list element is named by the corresponding time series key and contains the metadata as a named list. +} +\description{ +Read the time series metadata of a particular locale of the time series in a collection. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/read_collection_ts_release.Rd b/man/read_collection_ts_release.Rd new file mode 100644 index 0000000..8b00685 --- /dev/null +++ b/man/read_collection_ts_release.Rd @@ -0,0 +1,44 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{read_collection_ts_release} +\alias{read_collection_ts_release} +\title{Read collection time series vintage release} +\usage{ +read_collection_ts_release( + collection, + owner = "self", + valid_on = Sys.Date(), + ignore_missing = F +) +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with vintage date, release topic, year, period and time for every time series key. +} +\description{ +Read the vintage release information of the time series in a collection. The vintage is specified by the valid_on parameter. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/read_collection_ts_release_future.Rd b/man/read_collection_ts_release_future.Rd new file mode 100644 index 0000000..185e05e --- /dev/null +++ b/man/read_collection_ts_release_future.Rd @@ -0,0 +1,41 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{read_collection_ts_release_future} +\alias{read_collection_ts_release_future} +\title{Read collection time series release future} +\usage{ +read_collection_ts_release_future( + collection, + owner = "self", + ignore_missing = F +) +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with release topic, year, period and time for every time series key and future release. +} +\description{ +Read the release information of future time series vintages. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/read_collection_ts_release_history.Rd b/man/read_collection_ts_release_history.Rd new file mode 100644 index 0000000..7e21a6d --- /dev/null +++ b/man/read_collection_ts_release_history.Rd @@ -0,0 +1,47 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{read_collection_ts_release_history} +\alias{read_collection_ts_release_history} +\title{Read collection time series release history} +\usage{ +read_collection_ts_release_history( + collection, + owner = "self", + valid_from = as.Date("1900-01-01"), + valid_to = Sys.Date(), + ignore_missing = F +) +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} + +\item{valid_from}{Start date of the vintage range} + +\item{valid_to}{End date of the vintage range} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with vintage date, release topic, year, period and time for every time series key. +} +\description{ +Read the release information of multiple time series vintages. The vintage range is given by the valid_from and valid_to parameter. By default, the entire release history is read. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_write_time}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/read_collection_ts_write_time.Rd b/man/read_collection_ts_write_time.Rd new file mode 100644 index 0000000..33909ac --- /dev/null +++ b/man/read_collection_ts_write_time.Rd @@ -0,0 +1,44 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{read_collection_ts_write_time} +\alias{read_collection_ts_write_time} +\title{Read collection time series vintage write time} +\usage{ +read_collection_ts_write_time( + collection, + owner = "self", + valid_on = Sys.Date(), + ignore_missing = F +) +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with the vintage write time for every time series key. +} +\description{ +Read the time at which a time series vintage was written. The vintage is specified by the valid_on parameter. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{remove_ts_from_collection}()} +} +\concept{time series collection functions} diff --git a/man/read_dataset_keys.Rd b/man/read_dataset_keys.Rd new file mode 100644 index 0000000..12a8f66 --- /dev/null +++ b/man/read_dataset_keys.Rd @@ -0,0 +1,32 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{read_dataset_keys} +\alias{read_dataset_keys} +\title{Read dataset time series keys} +\usage{ +read_dataset_keys(dataset) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} +} +\value{ +Character vector of time series keys. +} +\description{ +Read the keys of the time series in a dataset. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{delete_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{read_dataset_ts_write_time}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/read_dataset_ts.Rd b/man/read_dataset_ts.Rd new file mode 100644 index 0000000..ed3f601 --- /dev/null +++ b/man/read_dataset_ts.Rd @@ -0,0 +1,36 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{read_dataset_ts} +\alias{read_dataset_ts} +\title{Read dataset time series} +\usage{ +read_dataset_ts(dataset, valid_on = Sys.Date(), ignore_missing = F) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +List of time series. Regular time series have the class ts and irregular time series the class xts. +} +\description{ +Read the time series in a dataset. The time series vintage is specified by the valid_on parameter. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{delete_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{read_dataset_ts_write_time}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/read_dataset_ts_history.Rd b/man/read_dataset_ts_history.Rd new file mode 100644 index 0000000..60062fe --- /dev/null +++ b/man/read_dataset_ts_history.Rd @@ -0,0 +1,45 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{read_dataset_ts_history} +\alias{read_dataset_ts_history} +\title{Read dataset time series history} +\usage{ +read_dataset_ts_history( + dataset, + valid_from = as.Date("1900-01-01"), + valid_to = Sys.Date(), + ignore_missing = F +) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{valid_from}{Start date of the vintage range} + +\item{valid_to}{End date of the vintage range} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +List of time series. +Regular time series have the class ts and irregular time series the class xts. +The name of each time series is the time series key concatenated with the vintage date in format YYYYMMDD. +} +\description{ +Read multiple vintages of the time series in a dataset The vintage range is given by the valid_from and valid_to parameter. By default, the entire history is read. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{delete_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{read_dataset_ts_write_time}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/read_dataset_ts_metadata.Rd b/man/read_dataset_ts_metadata.Rd new file mode 100644 index 0000000..f1a16c1 --- /dev/null +++ b/man/read_dataset_ts_metadata.Rd @@ -0,0 +1,36 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{read_dataset_ts_metadata} +\alias{read_dataset_ts_metadata} +\title{Read dataset time series metadata} +\usage{ +read_dataset_ts_metadata(dataset, locale = NULL, ignore_missing = F) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{locale}{The locale of the metadata. Can be any string, but ISO codes are recommended (such as 'en', 'de', 'fr', 'it'). Set to NULL for unlocalized metadata (default).} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +List of time series metadata. Each list element is named by the corresponding time series key and contains the metadata as a named list. +} +\description{ +Read the time series metadata of a particular locale of the time series in a dataset. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{delete_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{read_dataset_ts_write_time}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/read_dataset_ts_release.Rd b/man/read_dataset_ts_release.Rd new file mode 100644 index 0000000..af638b2 --- /dev/null +++ b/man/read_dataset_ts_release.Rd @@ -0,0 +1,36 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{read_dataset_ts_release} +\alias{read_dataset_ts_release} +\title{Read dataset time series vintage release} +\usage{ +read_dataset_ts_release(dataset, valid_on = Sys.Date(), ignore_missing = F) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with vintage date, release topic, year, period and time for every time series key. +} +\description{ +Read the vintage release information of the time series in a dataset. The vintage is specified by the valid_on parameter. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{delete_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{read_dataset_ts_write_time}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/read_dataset_ts_release_future.Rd b/man/read_dataset_ts_release_future.Rd new file mode 100644 index 0000000..f42ffdf --- /dev/null +++ b/man/read_dataset_ts_release_future.Rd @@ -0,0 +1,34 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{read_dataset_ts_release_future} +\alias{read_dataset_ts_release_future} +\title{Read dataset time series release future} +\usage{ +read_dataset_ts_release_future(dataset, ignore_missing = F) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with release topic, year, period and time for every time series key and future release. +} +\description{ +Read the release information of future time series vintages. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{delete_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{read_dataset_ts_write_time}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/read_dataset_ts_release_history.Rd b/man/read_dataset_ts_release_history.Rd new file mode 100644 index 0000000..a995fd5 --- /dev/null +++ b/man/read_dataset_ts_release_history.Rd @@ -0,0 +1,43 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{read_dataset_ts_release_history} +\alias{read_dataset_ts_release_history} +\title{Read dataset time series release history} +\usage{ +read_dataset_ts_release_history( + dataset, + valid_from = as.Date("1900-01-01"), + valid_to = Sys.Date(), + ignore_missing = F +) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{valid_from}{Start date of the vintage range} + +\item{valid_to}{End date of the vintage range} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with vintage date, release topic, year, period and time for every time series key. +} +\description{ +Read the release information of multiple time series vintages. The vintage range is given by the valid_from and valid_to parameter. By default, the entire release history is read. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{delete_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_write_time}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/read_dataset_ts_write_time.Rd b/man/read_dataset_ts_write_time.Rd new file mode 100644 index 0000000..dc2b1e6 --- /dev/null +++ b/man/read_dataset_ts_write_time.Rd @@ -0,0 +1,36 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{read_dataset_ts_write_time} +\alias{read_dataset_ts_write_time} +\title{Read dataset time series vintage write time} +\usage{ +read_dataset_ts_write_time(dataset, valid_on = Sys.Date(), ignore_missing = F) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with the vintage write time for every time series key. +} +\description{ +Read the time at which a time series vintage was written. The vintage is specified by the valid_on parameter. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{delete_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{write_dataset_ts_release}()} +} +\concept{dataset functions} diff --git a/man/read_ts.Rd b/man/read_ts.Rd new file mode 100644 index 0000000..50df397 --- /dev/null +++ b/man/read_ts.Rd @@ -0,0 +1,40 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{read_ts} +\alias{read_ts} +\title{Read time series} +\usage{ +read_ts(ts_keys, valid_on = Sys.Date(), ignore_missing = F) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +List of time series. Regular time series have the class ts and irregular time series the class xts. +} +\description{ +Read time series given by their unique identifiers (keys). The vintage is specified by the valid_on parameter. +By default, the most recent vintage is read. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/read_ts_dataset.Rd b/man/read_ts_dataset.Rd new file mode 100644 index 0000000..cf01161 --- /dev/null +++ b/man/read_ts_dataset.Rd @@ -0,0 +1,38 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{read_ts_dataset} +\alias{read_ts_dataset} +\title{Read time series dataset} +\usage{ +read_ts_dataset(ts_keys, ignore_missing = F) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with dataset name for every time series key. +} +\description{ +Read the dataset the time series belongs to. +Every time series can belong to only one dataset. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/read_ts_history.Rd b/man/read_ts_history.Rd new file mode 100644 index 0000000..b5d103b --- /dev/null +++ b/man/read_ts_history.Rd @@ -0,0 +1,48 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{read_ts_history} +\alias{read_ts_history} +\title{Read time series history} +\usage{ +read_ts_history( + ts_keys, + valid_from = NULL, + valid_to = Sys.Date(), + ignore_missing = F +) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{valid_from}{Start date of the vintage range} + +\item{valid_to}{End date of the vintage range} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +List of time series. +Regular time series have the class ts and irregular time series the class xts. +The name of each time series is the time series key concatenated with the vintage date in format YYYYMMDD. +} +\description{ +Read multiple time series vintages. The vintage range is given by the valid_from and valid_to parameters. By default, the entire history is read. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/read_ts_metadata.Rd b/man/read_ts_metadata.Rd new file mode 100644 index 0000000..ce2592e --- /dev/null +++ b/man/read_ts_metadata.Rd @@ -0,0 +1,39 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{read_ts_metadata} +\alias{read_ts_metadata} +\title{Read time series metadata} +\usage{ +read_ts_metadata(ts_keys, locale = NULL, ignore_missing = F) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{locale}{The locale of the metadata. Can be any string, but ISO codes are recommended (such as 'en', 'de', 'fr', 'it'). Set to NULL for unlocalized metadata (default).} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +List of time series metadata. Each list element is named by the corresponding time series key and contains the metadata as a named list. +} +\description{ +Read the time series metadata of a particular locale. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/read_ts_release.Rd b/man/read_ts_release.Rd new file mode 100644 index 0000000..5a531dd --- /dev/null +++ b/man/read_ts_release.Rd @@ -0,0 +1,40 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{read_ts_release} +\alias{read_ts_release} +\title{Read time series vintage release} +\usage{ +read_ts_release(ts_keys, valid_on = Sys.Date(), ignore_missing = F) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with vintage date, release topic, year, period and time for every time series key. +} +\description{ +Read the time series vintage release information. +The vintage is specified by the valid_on parameter. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/read_ts_release_future.Rd b/man/read_ts_release_future.Rd new file mode 100644 index 0000000..12ed294 --- /dev/null +++ b/man/read_ts_release_future.Rd @@ -0,0 +1,37 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{read_ts_release_future} +\alias{read_ts_release_future} +\title{Read time series release future} +\usage{ +read_ts_release_future(ts_keys, ignore_missing = F) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with release topic, year, period and time for every time series key and future release. +} +\description{ +Read the release information of future time series vintages. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/read_ts_release_history.Rd b/man/read_ts_release_history.Rd new file mode 100644 index 0000000..67b783b --- /dev/null +++ b/man/read_ts_release_history.Rd @@ -0,0 +1,48 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{read_ts_release_history} +\alias{read_ts_release_history} +\title{Read time series vintage release history} +\usage{ +read_ts_release_history( + ts_keys, + valid_from = NULL, + valid_to = NULL, + ignore_missing = F +) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{valid_from}{Start date of the vintage range} + +\item{valid_to}{End date of the vintage range} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with vintage date, release topic, year, period and time for every time series key. +} +\description{ +Read the release information of multiple time series vintages. +The vintage range is given by the valid_from and valid_to parameters. +By default, the entire release history is read. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/read_ts_write_time.Rd b/man/read_ts_write_time.Rd new file mode 100644 index 0000000..d18880a --- /dev/null +++ b/man/read_ts_write_time.Rd @@ -0,0 +1,40 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{read_ts_write_time} +\alias{read_ts_write_time} +\title{Read time series vintage write time} +\usage{ +read_ts_write_time(ts_keys, valid_on = Sys.Date(), ignore_missing = F) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\value{ +Table with the vintage write time for every time series key. +} +\description{ +Read the time at which a time series vintage was written. +The vintage is specified by the valid_on parameter. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/read_user_quota.Rd b/man/read_user_quota.Rd new file mode 100644 index 0000000..eb5ceda --- /dev/null +++ b/man/read_user_quota.Rd @@ -0,0 +1,17 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/users.R +\name{read_user_quota} +\alias{read_user_quota} +\title{Read user quota} +\usage{ +read_user_quota(username = "self") +} +\arguments{ +\item{username}{Username of the time series database user} +} +\value{ +Table with quota information. +} +\description{ +Check the number of time series downloads remaining in the current subscription year. +} diff --git a/man/remove_ts_from_access_set.Rd b/man/remove_ts_from_access_set.Rd new file mode 100644 index 0000000..1865a20 --- /dev/null +++ b/man/remove_ts_from_access_set.Rd @@ -0,0 +1,25 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/access_sets.R +\name{remove_ts_from_access_set} +\alias{remove_ts_from_access_set} +\title{Remove time series from access set} +\usage{ +remove_ts_from_access_set(access_set, ts_keys) +} +\arguments{ +\item{access_set}{Name of the access set. An access set is a group of time series for which a permission (read_quota, read, read_before_release, write) can be granted to individual users. Every time series can be a member of multiple access sets.} + +\item{ts_keys}{Character vector of time series identifiers (keys)} +} +\description{ +Remove time series (given by their keys) from a time series access set. +} +\seealso{ +Other access set functions: +\code{\link{add_ts_to_access_set}()}, +\code{\link{create_access_set}()}, +\code{\link{delete_access_set}()}, +\code{\link{list_access_sets}()}, +\code{\link{read_access_set_keys}()} +} +\concept{access set functions} diff --git a/man/remove_ts_from_collection.Rd b/man/remove_ts_from_collection.Rd new file mode 100644 index 0000000..d8f38d6 --- /dev/null +++ b/man/remove_ts_from_collection.Rd @@ -0,0 +1,34 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/collections.R +\name{remove_ts_from_collection} +\alias{remove_ts_from_collection} +\title{Remove time series from collection} +\usage{ +remove_ts_from_collection(collection, owner = "self", ts_keys) +} +\arguments{ +\item{collection}{Name of the time series collection} + +\item{owner}{Username of the owner of the time series collection} + +\item{ts_keys}{Character vector of time series identifiers (keys)} +} +\description{ +Remove existing time series (given by their keys) from a time series collection. +} +\seealso{ +Other time series collection functions: +\code{\link{add_ts_to_collection}()}, +\code{\link{create_collection}()}, +\code{\link{delete_collection}()}, +\code{\link{list_collections}()}, +\code{\link{read_collection_keys}()}, +\code{\link{read_collection_ts}()}, +\code{\link{read_collection_ts_history}()}, +\code{\link{read_collection_ts_metadata}()}, +\code{\link{read_collection_ts_release}()}, +\code{\link{read_collection_ts_release_future}()}, +\code{\link{read_collection_ts_release_history}()}, +\code{\link{read_collection_ts_write_time}()} +} +\concept{time series collection functions} diff --git a/man/remove_user_access_sets.Rd b/man/remove_user_access_sets.Rd new file mode 100644 index 0000000..7ac7d70 --- /dev/null +++ b/man/remove_user_access_sets.Rd @@ -0,0 +1,27 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/users.R +\name{remove_user_access_sets} +\alias{remove_user_access_sets} +\title{Remove user access sets} +\usage{ +remove_user_access_sets(username = "self", access_sets) +} +\arguments{ +\item{username}{Username of the time series database user} + +\item{access_sets}{Names of the access sets. An access set is a group of time series for which a permission (one of read_quota, read, read_before_release or write) can be granted to users. A time series can be a member of multiple access sets.} +} +\description{ +Remove access sets and associated permissions from a user. +} +\seealso{ +Other user management functions: +\code{\link{add_user_access_sets}()}, +\code{\link{create_user_api_key}()}, +\code{\link{create_user_quota}()}, +\code{\link{delete_user_quota}()}, +\code{\link{list_user_access_sets}()}, +\code{\link{list_users}()}, +\code{\link{write_user_quota}()} +} +\concept{user management functions} diff --git a/man/rename_ts.Rd b/man/rename_ts.Rd new file mode 100644 index 0000000..08eff34 --- /dev/null +++ b/man/rename_ts.Rd @@ -0,0 +1,37 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{rename_ts} +\alias{rename_ts} +\title{Rename time series} +\usage{ +rename_ts(ts_keys, ts_keys_new, ignore_missing = F) +} +\arguments{ +\item{ts_keys}{Existing time series keys} + +\item{ts_keys_new}{New time series keys} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\description{ +Change the time series' unique identifiers (keys). +The length of the parameters ts_keys and ts_keys_new must be the same. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/set_config.Rd b/man/set_config.Rd new file mode 100644 index 0000000..e302b8c --- /dev/null +++ b/man/set_config.Rd @@ -0,0 +1,61 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/utils.R +\name{set_config} +\alias{set_config} +\title{Set package configuration} +\usage{ +set_config( + oauth_client_id = NULL, + oauth_token_url = NULL, + oauth_auth_url = NULL, + oauth_auth_device_url = NULL, + oauth_flow = NULL, + oauth_redirect_url = NULL, + api_key = NULL, + url_staging = NULL, + url_production = NULL, + url_test = NULL, + environment = NULL, + access_type = NULL, + read_before_release = NULL +) +} +\arguments{ +\item{oauth_client_id}{OAuth client ID.} + +\item{oauth_token_url}{OAuth token URL} + +\item{oauth_auth_url}{OAuth authorization URL} + +\item{oauth_auth_device_url}{OAuth device authorization URL} + +\item{oauth_flow}{OAuth authorization flow. Must be either 'device' (default for hosted sessions) or 'code' (default otherwise).} + +\item{oauth_redirect_url}{OAuth redirect URL} + +\item{api_key}{API key for programmatic access. Use \code{\link[tsdbapi]{create_user_api_key}} to create an API key.} + +\item{url_staging}{URL of staging API} + +\item{url_production}{URL of production API} + +\item{url_test}{URL of test API} + +\item{environment}{Whether to use the production, staging or test API. Must be one of 'production', 'staging' or 'test.} + +\item{access_type}{How to access time series data. Must be one of 'auth' (the default), 'public' or 'preview'. +The access types 'public' and 'preview' bypass authentication. +Use the access type 'public' to read public time series and the access type 'preview' to read time series previews (latest 2 years of data missing). +Use 'auth' for authenticated access.} + +\item{read_before_release}{Whether to read time series vintages before their official release. Defaults to TRUE. This option will only have +an effect if you have pre release access to the requested time series.} +} +\description{ +Set the package configuration options for the current session. Every option is initialized with the corresponding environment variable on package load. +} +\seealso{ +Other package configuration functions: +\code{\link{get_config}()} +} +\concept{package configuration functions} diff --git a/man/write_dataset_ts_release.Rd b/man/write_dataset_ts_release.Rd new file mode 100644 index 0000000..a0b7c46 --- /dev/null +++ b/man/write_dataset_ts_release.Rd @@ -0,0 +1,46 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{write_dataset_ts_release} +\alias{write_dataset_ts_release} +\title{Write dataset time series release} +\usage{ +write_dataset_ts_release( + dataset, + release_topic, + release_year, + release_period, + valid_on = Sys.Date(), + ignore_missing = F +) +} +\arguments{ +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} + +\item{release_topic}{Topic of the release. For example 'kofbaro'.} + +\item{release_year}{Year of the release} + +\item{release_period}{Period of the release. For monthly releases a number from 1 to 12. For quarterly releases a number from 1 to 4. For half-yearly releases a number from 1 to 2. For yearly releases always 1.} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} + +\item{ignore_missing}{Whether to ignore missing or forbidden time series when requesting time series data} +} +\description{ +Write the release information for a vintage of the time series in a dataset. The vintage is specified by the valid_on parameter. +} +\seealso{ +Other dataset functions: +\code{\link{create_dataset}()}, +\code{\link{delete_dataset}()}, +\code{\link{list_datasets}()}, +\code{\link{read_dataset_keys}()}, +\code{\link{read_dataset_ts}()}, +\code{\link{read_dataset_ts_history}()}, +\code{\link{read_dataset_ts_metadata}()}, +\code{\link{read_dataset_ts_release}()}, +\code{\link{read_dataset_ts_release_future}()}, +\code{\link{read_dataset_ts_release_history}()}, +\code{\link{read_dataset_ts_write_time}()} +} +\concept{dataset functions} diff --git a/man/write_ts.Rd b/man/write_ts.Rd new file mode 100644 index 0000000..bf4ef66 --- /dev/null +++ b/man/write_ts.Rd @@ -0,0 +1,59 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{write_ts} +\alias{write_ts} +\title{Write time series} +\usage{ +write_ts( + ts_list, + valid_from = Sys.Date(), + access_sets = character(), + release_topic = NULL, + release_year = NULL, + release_period = NULL, + access = NULL, + pre_release_access = NULL, + release_date = NULL +) +} +\arguments{ +\item{ts_list}{Named list of time series of class, zoo or xts with time series keys as list names} + +\item{valid_from}{Vintage date of the time series. Defaults to the current date.} + +\item{access_sets}{Names of the access sets the time series are added to. +If new time series are written, you must provide at least one access set name.} + +\item{release_topic}{Topic of the release. For example 'kofbaro'.} + +\item{release_year}{Year of the release} + +\item{release_period}{Period of the release. For monthly releases a number from 1 to 12. For quarterly releases a number from 1 to 4. For half-yearly releases a number from 1 to 2. For yearly releases always 1.} + +\item{access}{The access level of the time series. This parameter is obsolete once the Time Series DB API v1 is discontinued.} + +\item{pre_release_access}{The access level of the time series before the time of release. This parameter is obsolete once the Time Series DB API v1 is discontinued.} + +\item{release_date}{Time of the release (POSIXct). This parameter is obsolete once the Time Series DB API v1 is discontinued.} +} +\description{ +Write time series as a particular vintage (given by the valid_from parameter). +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/write_ts_dataset.Rd b/man/write_ts_dataset.Rd new file mode 100644 index 0000000..f56e3e6 --- /dev/null +++ b/man/write_ts_dataset.Rd @@ -0,0 +1,34 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{write_ts_dataset} +\alias{write_ts_dataset} +\title{Write time series dataset} +\usage{ +write_ts_dataset(ts_keys, dataset) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{dataset}{Name of the dataset. A dataset is a group of time series with a common theme. Every time series can belong to only one dataset.} +} +\description{ +Assign time series to a dataset. Every time series can belong to only one dataset. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_metadata}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/write_ts_metadata.Rd b/man/write_ts_metadata.Rd new file mode 100644 index 0000000..3c9ad28 --- /dev/null +++ b/man/write_ts_metadata.Rd @@ -0,0 +1,37 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{write_ts_metadata} +\alias{write_ts_metadata} +\title{Write time series metadata} +\usage{ +write_ts_metadata(metadata_list, locale = NULL, overwrite = F) +} +\arguments{ +\item{metadata_list}{List of time series metadata named by the time series keys. +Each list element contains the metadata of a time series as a named list (key-value pairs).} + +\item{locale}{The locale of the metadata. Can be any string, but ISO codes are recommended (such as 'en', 'de', 'fr', 'it'). Set to NULL for unlocalized metadata (default).} + +\item{overwrite}{If TRUE, the existing metadata is replaced completely. If FALSE (default), new fields are added and existing fields are updated.} +} +\description{ +Write time series metadata of a particular locale. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_release}()} +} +\concept{time series functions} diff --git a/man/write_ts_release.Rd b/man/write_ts_release.Rd new file mode 100644 index 0000000..2997bd4 --- /dev/null +++ b/man/write_ts_release.Rd @@ -0,0 +1,46 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/time_series.R +\name{write_ts_release} +\alias{write_ts_release} +\title{Write time series release} +\usage{ +write_ts_release( + ts_keys, + release_topic, + release_year, + release_period, + valid_on = Sys.Date() +) +} +\arguments{ +\item{ts_keys}{Character vector of time series identifiers (keys)} + +\item{release_topic}{Topic of the release. For example 'kofbaro'.} + +\item{release_year}{Year of the release} + +\item{release_period}{Period of the release. For monthly releases a number from 1 to 12. For quarterly releases a number from 1 to 4. For half-yearly releases a number from 1 to 2. For yearly releases always 1.} + +\item{valid_on}{Selects the time series vintage with the vintage date equal to or before this date} +} +\description{ +Write release information for a time series vintage. The vintage is specified by the valid_on parameter. +} +\seealso{ +Other time series functions: +\code{\link{delete_ts}()}, +\code{\link{find_ts}()}, +\code{\link{read_ts}()}, +\code{\link{read_ts_dataset}()}, +\code{\link{read_ts_history}()}, +\code{\link{read_ts_metadata}()}, +\code{\link{read_ts_release}()}, +\code{\link{read_ts_release_future}()}, +\code{\link{read_ts_release_history}()}, +\code{\link{read_ts_write_time}()}, +\code{\link{rename_ts}()}, +\code{\link{write_ts}()}, +\code{\link{write_ts_dataset}()}, +\code{\link{write_ts_metadata}()} +} +\concept{time series functions} diff --git a/man/write_user_quota.Rd b/man/write_user_quota.Rd new file mode 100644 index 0000000..11d981c --- /dev/null +++ b/man/write_user_quota.Rd @@ -0,0 +1,33 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/users.R +\name{write_user_quota} +\alias{write_user_quota} +\title{Write user quota} +\usage{ +write_user_quota( + username, + current_year_quota = NULL, + subscription_annual_quota = NULL +) +} +\arguments{ +\item{username}{Username of the time series database user} + +\item{current_year_quota}{Download quota of the current year. It is automatically set to subscription_annual_quota at the start of a subscription year.} + +\item{subscription_annual_quota}{Annual download quota of data service subscription} +} +\description{ +Set a user's quota for the current subscription year and/or the subscription's default annual quota. +} +\seealso{ +Other user management functions: +\code{\link{add_user_access_sets}()}, +\code{\link{create_user_api_key}()}, +\code{\link{create_user_quota}()}, +\code{\link{delete_user_quota}()}, +\code{\link{list_user_access_sets}()}, +\code{\link{list_users}()}, +\code{\link{remove_user_access_sets}()} +} +\concept{user management functions}