Package 'rjd3providers'

Title: Interface to 'JDemetra+ 3.x' time series analysis software
Description: Interface to 'JDemetra+ 3.x' (<https://github.com/jdemetra>) time series analysis software. It offers full access to txt, csv, xml and spreadsheets files which are meant to be read by JDemetra+ Graphical User Interface.
Authors: Jean Palate [aut], Alessandro Piovani [aut, cre], Tanguy Barthelemy [ctb, art]
Maintainer: Alessandro Piovani <[email protected]>
License: file LICENSE
Version: 3.4.0
Built: 2025-04-01 09:20:39 UTC
Source: https://github.com/rjdverse/rjd3providers

Help Index


Generates a java moniker for the corresponding id

Description

Generates a java moniker for the corresponding id

Usage

.spreadsheet_moniker(id)

Arguments

id

Generates a java moniker for the corresponding id

Description

Generates a java moniker for the corresponding id

Usage

.txt_moniker(id)

Arguments

id

Title

Description

Title

Usage

set_spreadsheet_paths(paths)

Arguments

paths

Title

Description

Title

Usage

set_txt_paths(paths)

Arguments

paths

Set the paths of the provider

Description

Set the paths of the provider

Usage

set_xml_paths(paths)

Arguments

paths

Examples

set_xml_paths(system.file("examples", package = "rjd3providers"))

Change the file of a moniker

Description

Change the file of a moniker

Usage

spreadsheet_change_file(id, nfile, ofile = NULL)

Arguments

id

Identifier of the series (from its moniker)

nfile

New file name

ofile

Old file name. NULL or "" to change any file to the new file


Title

Description

Title

Usage

spreadsheet_content(file)

Arguments

file

Title

Description

Title

Usage

spreadsheet_data(
  file,
  sheet = 1,
  period = 0,
  aggregation = c("None", "Sum", "Average", "First", "Last", "Max", "Min"),
  partialAggregation = FALSE,
  cleanMissings = TRUE,
  fullNames = FALSE
)

Arguments

fullNames

Examples

set_spreadsheet_paths(system.file("examples", package = "rjd3providers"))
xls_all <- spreadsheet_data("Insee.xlsx", 1)

Gets the list of the properties corresponding to the identifier of a moniker

Description

Gets the list of the properties corresponding to the identifier of a moniker

Usage

spreadsheet_id_properties(id)

Arguments

id

Title

Description

Title

Usage

spreadsheet_name()

Title

Description

Title

Usage

spreadsheet_series(
  file,
  sheet = 1,
  series = 1,
  period = 0,
  aggregation = c("None", "Sum", "Average", "First", "Last", "Max", "Min"),
  partialAggregation = FALSE,
  cleanMissings = TRUE,
  fullName = TRUE
)

Arguments

fullName

Generates the id corresponding to a list of properties

Description

Generates the id corresponding to a list of properties

Usage

spreadsheet_to_id(props)

Arguments

props

Title

Description

Title

Usage

txt_change_file(id, nfile, ofile = NULL)

Arguments

id

Identifier of the series (from its moniker)

nfile

New file name

ofile

Old file name. NULL or "" to change any file to the new file


Title

Description

Title

Usage

txt_content(
  file,
  fmt.locale = NULL,
  fmt.date = NULL,
  fmt.number = NULL,
  fmt.ignoreNumberGrouping = TRUE,
  gathering.period = 0,
  gathering.aggregation = c("None", "Sum", "Average", "First", "Last", "Max", "Min"),
  gathering.partialAggregation = FALSE,
  gathering.includeMissing = TRUE,
  charset = NULL,
  delimiter = c("TAB", "SEMICOLON", "COMMA", "SPACE"),
  txtQualifier = c("NONE", "QUOTE", "DOUBLE_QUOTE"),
  header = TRUE,
  skip = 0
)

Arguments

skip

Examples

set_txt_paths(system.file("examples", package = "rjd3providers"))
txt_all <- txt_content("ABS.csv", delimiter = "COMMA")

Title

Description

Title

Usage

txt_data(
  file,
  fmt.locale = NULL,
  fmt.date = NULL,
  fmt.number = NULL,
  fmt.ignoreNumberGrouping = TRUE,
  gathering.period = 0,
  gathering.aggregation = c("None", "Sum", "Average", "First", "Last", "Max", "Min"),
  gathering.partialAggregation = FALSE,
  gathering.includeMissing = TRUE,
  charset = NULL,
  delimiter = c("TAB", "SEMICOLON", "COMMA", "SPACE"),
  txtQualifier = c("NONE", "QUOTE", "DOUBLE_QUOTE"),
  header = TRUE,
  skip = 0
)

Arguments

skip

Examples

set_txt_paths(system.file("examples", package = "rjd3providers"))
all <- txt_data("ABS.csv", delimiter = "COMMA")

Gets the list of the properties corresponding to the identifier of a moniker

Description

Gets the list of the properties corresponding to the identifier of a moniker

Usage

txt_id_properties(id)

Arguments

id

Title

Description

Title

Usage

txt_name()

Title

Description

Title

Usage

txt_series(
  file,
  series,
  fmt.locale = NULL,
  fmt.date = NULL,
  fmt.number = NULL,
  fmt.ignoreNumberGrouping = TRUE,
  gathering.period = 0,
  gathering.aggregation = c("None", "Sum", "Average", "First", "Last", "Max", "Min"),
  gathering.partialAggregation = FALSE,
  gathering.includeMissing = TRUE,
  charset = NULL,
  delimiter = c("TAB", "SEMICOLON", "COMMA", "SPACE"),
  txtQualifier = c("NONE", "QUOTE", "DOUBLE_QUOTE"),
  header = TRUE,
  skip = 0
)

Arguments

skip

Examples

set_txt_paths(system.file("examples", package = "rjd3providers"))
txt_5 <- txt_series("ABS.csv", series = 15, delimiter = "COMMA")

Generates the id corresponding to a list of properties

Description

Generates the id corresponding to a list of properties

Usage

txt_to_id(props)

Arguments

props

Change the file of a moniker

Description

Change the file of a moniker

Usage

xml_change_file(id, nfile, ofile = NULL)

Arguments

id

Identifier of the series (from its moniker)

nfile

New file name

ofile

Old file name. NULL or "" to change any file to the new file


Title

Description

Title

Usage

xml_content(file, charset = NULL)

Arguments

file

Examples

set_xml_paths(system.file("examples", package = "rjd3providers"))
xml_content("Prod.xml")

Title

Description

Title

Usage

xml_data(file, collection = 1, charset = NULL, fullNames = FALSE)

Arguments

fullNames

Examples

set_xml_paths(system.file("examples", package = "rjd3providers"))
xml_all <- xml_data("Prod.xml", 1, charset = "iso-8859-1")

Gets the list of the properties corresponding to the identifier of a moniker

Description

Gets the list of the properties corresponding to the identifier of a moniker

Usage

xml_id_properties(id)

Arguments

id

Examples

set_xml_paths(system.file("examples", package = "rjd3providers"))
xml_1_5 <- xml_series("Prod.xml", 1, 5, charset = "iso-8859-1")
xml_id_properties(xml_1_5$moniker$id)

Gets the name of the provider

Description

Gets the name of the provider

Usage

xml_name()

Examples

xml_name()

Title

Description

Title

Usage

xml_series(file, collection = 1, series = 1, charset = NULL, fullName = TRUE)

Arguments

fullName

Examples

set_xml_paths(system.file("examples", package = "rjd3providers"))
xml_1_5 <- xml_series("Prod.xml", 1, 5, charset = "iso-8859-1")

Generates the id corresponding to a list of properties

Description

Generates the id corresponding to a list of properties

Usage

xml_to_id(props)

Arguments

props

Examples

set_xml_paths(system.file("examples", package = "rjd3providers"))
xml_1_5 <- xml_series("Prod.xml", 1, 5, charset = "iso-8859-1")
q <- xml_id_properties(xml_1_5$moniker$id)
q$series <- 50
xml_to_id(q)