restatis (version 0.2.0)

gen_list_jobs: gen_list_jobs

Description

Function to list all current jobs connected to the given user in the GENESIS or regionalstatistik.de database. Important note: For this function it is also possible to use searchcriterion parameter and selection parameter, making it possible to filter the job list based on 'type','time','status' or 'code'. For more details see vignette("additional_parameter").

Usage

gen_list_jobs(
  database = c("genesis", "regio"),
  sortcriterion = c("type", "time", "status", "code"),
  flat = FALSE,
  ...
)

Value

A list or data.frame (see parameter 'flat') of all current jobs of the user.

Arguments

database

Character string. Indicator if 'genesis' or 'regionalstatistik.de' database is called. Default option is 'genesis'.

sortcriterion

Character string. Indicator if the output should be sorted by 'type','time','status' or 'code'. This is a parameter of the API call itself. The default is 'type'.

flat

Boolean. Should the function return a list with jobs and metadata ('FALSE') or just a flat data.frame ('TRUE')? Defaults to FALSE.

...

Additional parameters for the API call. These parameters are only affecting the call itself, no further processing. For more details see vignette("additional_parameter").

Examples

if (FALSE) {
gen_list_jobs("regio", flat = TRUE)
}