Generates the Java object for data formats

Description

Generates the Java object for data formats

Usage

.obs_format(
  locale = NULL,
  dateFmt = NULL,
  numberFmt = NULL,
  ignoreNumberGrouping = TRUE
)

Arguments

Value

An internal Java object.

Examples

.obs_format(locale = "french-be")

Generates the Java object for automatic aggregation of the data

Description

Generates the Java object for automatic aggregation of the data

Usage

.obs_gathering(
  period = 0,
  aggregationType = NULL,
  allowPartialAggregation = FALSE,
  cleanMissing = TRUE
)

Arguments

Value

An internal Java object.

Examples

.obs_gathering(period=4, aggregationType="Sum")

Generates a java moniker for the corresponding id.

Description

Generates a java moniker for the corresponding id.

Usage

.spreadsheet_moniker(id)

Arguments

Value

An internal Java moniker.

Examples

.spreadsheet_moniker("toy_id")

Generates a java moniker for the corresponding id.

Description

Generates a java moniker for the corresponding id.

Usage

.txt_moniker(id)

Arguments

Value

An internal java moniker.

Examples

.txt_moniker("toy_id")

Generates a java moniker for the corresponding id.

Description

Generates a java moniker for the corresponding id.

Usage

.xml_moniker(id)

Arguments

Value

An internal java moniker.

Examples

.xml_moniker("toy_id")

Deprecated functions

Description

These functions are deprecated and are kept only for backward compatibility. Users should use the corresponding non-deprecated functions instead:

• spreadsheet_to_id() \to spreadsheet_properties_to_id()

• spreadsheet_id_properties() \to spreadsheet_id_to_properties()

• txt_to_id() \to txt_properties_to_id()

• txt_id_properties() \to txt_id_to_properties()

• xml_to_id() \to xml_properties_to_id()

• xml_id_properties() \to xml_id_to_properties()

Usage

spreadsheet_to_id(props)

spreadsheet_id_properties(id)

txt_to_id(props)

txt_id_properties(id)

xml_to_id(props)

xml_id_properties(id)

Arguments

Value

The same value as returned by the corresponding non-deprecated function. The returned object represents an encoded identifier for a spreadsheet series or collection.

The same output as spreadsheet_id_to_properties. It is a list with the elements of the identifier: file, sheet, series, and gathering (which contains period, aggregation, partialAggregation, and cleanMissing flags).

The same output as txt_properties_to_id(): a string representing the internal identifier.

The same output as txt_id_to_properties(): a list with the elements of the id (file, series, format, gathering, etc.).

Returns the same output as xml_properties_to_id(): an internal identifier corresponding to the XML properties.

Returns the same output as xml_id_to_properties(): a list of the XML identifier’s properties (file, collection[, series], charset, fullNames).

Examples

# Deprecated: use spreadsheet_properties_to_id() instead
set_spreadsheet_paths(system.file("extdata", package = "rjd3providers"))
xls_s1_3 <- spreadsheet_series("Insee.xlsx", 1, 3)
id<-xls_s1_3$moniker$id
source<-spreadsheet_name()
# props<-spreadsheet_id_properties(xls_s1_3$moniker$id) # DEPRECATED
props<-spreadsheet_id_to_properties(xls_s1_3$moniker$id) # RECOMMENDED
props$gathering$period<-4
props$gathering$aggregation<-"Max"
# M<-rjd3toolkit::to_ts(spreadsheet_name(),
#                       spreadsheet_to_id(props))
M<-rjd3toolkit::to_ts(spreadsheet_name(), # DEPRECATED
                      spreadsheet_properties_to_id(props)) # RECOMMENDED
props$gathering$aggregation<-"Min"
# m<-rjd3toolkit::to_ts(spreadsheet_name(),
#                       spreadsheet_to_id(props)) # DEPRECATED
m<-rjd3toolkit::to_ts(spreadsheet_name(),
                      spreadsheet_properties_to_id(props)) # RECOMMENDED
ts.plot(ts.union(M$data,m$data), col=c("red", "blue"))



# Deprecated: use spreadsheet_id_to_properties() instead
set_spreadsheet_paths(system.file("extdata", package = "rjd3providers"))
xls_s1_3 <- spreadsheet_series("Insee.xlsx", 1, 3)
id<-xls_s1_3$moniker$id
# print(spreadsheet_id_properties(id)) # DEPRECATED
print(spreadsheet_id_to_properties(id)) # RECOMMENDED


# Deprecated: use txt_properties_to_id() instead
set_txt_paths(system.file("extdata", package = "rjd3providers"))
txt_15 <- txt_series("ABS.csv", series = 15, delimiter = "COMMA")
id<-txt_15$moniker$id
source<-txt_name()
# props<-txt_id_properties(id) # DEPRECATED
props<-txt_id_to_properties(id) # RECOMMENDED
props$gathering$period<-4
props$gathering$aggregation<-"Max"
# M<-rjd3toolkit::to_ts(txt_name(), txt_to_id(props)) # DEPRECATED
M<-rjd3toolkit::to_ts(txt_name(), txt_properties_to_id(props)) # RECOMMENDED
props$gathering$aggregation<-"Min"
# m<-rjd3toolkit::to_ts(txt_name(), txt_to_id(props)) # DEPRECATED
m<-rjd3toolkit::to_ts(txt_name(), txt_properties_to_id(props)) # RECOMMENDED
ts.plot(ts.union(M$data,m$data), col=c("red", "blue"))


# Deprecated: use txt_id_to_properties() instead
set_txt_paths(system.file("extdata", package = "rjd3providers"))
txt_15 <- txt_series("ABS.csv", series = 15, delimiter = "COMMA")
id<-txt_15$moniker$id
# print(txt_id_properties(id)) # DEPRECATED
print(txt_id_to_properties(id)) # RECOMMENDED


# Deprecated: use xml_properties_to_id() instead
set_xml_paths(system.file("extdata", package = "rjd3providers"))
xml_1_5 <- xml_series("Prod.xml", 1, 5, charset = "iso-8859-1")
# q <- xml_id_properties(xml_1_5$moniker$id) # DEPRECATED
q <- xml_id_to_properties(xml_1_5$moniker$id) # RECOMMENDED
q$series <- 50
# xml_to_id(q) # DEPRECATED
xml_properties_to_id(q) # RECOMMENDED



# Deprecated: use xml_id_to_properties() instead
set_xml_paths(system.file("extdata", package = "rjd3providers"))
xml_1_5 <- xml_series("Prod.xml", 1, 5, charset = "iso-8859-1")
# xml_id_properties(xml_1_5$moniker$id) # DEPRECATED
xml_id_to_properties(xml_1_5$moniker$id) # RECOMMENDED
xml_1 <- xml_data("Prod.xml", 1, charset = "iso-8859-1")
# xml_id_properties(xml_1$moniker$id) # DEPRECATED
xml_id_to_properties(xml_1$moniker$id) # RECOMMENDED

Java version.

Description

Java version.

Usage

current_java_version

minimal_java_version

Format

An object of class integer of length 1.

An object of class numeric of length 1.

Value

current_java_version is the current Java version and minimal_java_version is the minimum accepted Java version.

Examples

print(minimal_java_version)
print(current_java_version)

Set the paths to spreadsheet files (to be used with relative identifiers).

Description

Set the paths to spreadsheet files (to be used with relative identifiers).

Usage

set_spreadsheet_paths(paths)

Arguments

Value

No output.

Examples

set_spreadsheet_paths(system.file("extdata", package = "rjd3providers"))

Set the paths to txt files (to be used with relative identifiers)

Description

Set the paths to txt files (to be used with relative identifiers)

Usage

set_txt_paths(paths)

Arguments

Value

An internal java moniker

Examples

set_txt_paths(system.file("extdata", package = "rjd3providers"))

Set the paths to xml files (to be used with relative identifiers).

Description

Set the paths to xml files (to be used with relative identifiers).

Usage

set_xml_paths(paths)

Arguments

Value

No output.

Examples

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

Change the file of a spreadsheet moniker.

Description

Change the file of a spreadsheet moniker.

Usage

spreadsheet_change_file(id, nfile, ofile = NULL)

Arguments

Value

Returns the new identifier.

Examples

set_spreadsheet_paths(system.file("extdata", package = "rjd3providers"))
xls_all <- spreadsheet_data("Insee.xlsx", 1)
id<-xls_all$moniker$id
spreadsheet_change_file(id, "test.xlsx")

Provides the content of a spreadsheet designed for time series.

Description

Provides the content of a spreadsheet designed for time series.

Usage

spreadsheet_content(file)

Arguments

Value

Provides all the names of the time series contained in the workbook, organized by worksheet; the output is a list of lists of names.

Examples

set_spreadsheet_paths(system.file("extdata", package = "rjd3providers"))
print(spreadsheet_content("Insee.xlsx"))

Retrieves all the time series in a specified sheet from a spreadsheet file.

Description

Retrieves all the time series in a specified sheet from a spreadsheet file.

Usage

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

Arguments

Value

A ts collection with all the series.

Examples

set_spreadsheet_paths(system.file("extdata", package = "rjd3providers"))
xls_all <- spreadsheet_data("Insee.xlsx", 1)
txt_all <- spreadsheet_data("Insee.xlsx", "FRANCE Textile")

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_to_properties(id)

Arguments

Details

When the period in the gathering list is defined, the user must specify the aggregation type ("Sum", "Average", "First", "Last", "Min", "Max") and some additional parameters (partial aggregation and suppression of leading/trailing missing values).

Value

Returns a list with the elements of the id: file, sheet, series, gathering); the gathering is a list with the following items: period (-1 by default), the aggregation ("None"), partialAggregation (FALSE), includeMissing (FALSE).

See Also

[spreadsheet_properties_to_id()]

Examples

set_spreadsheet_paths(system.file("extdata", package = "rjd3providers"))
xls_s1_3 <- spreadsheet_series("Insee.xlsx", 1, 3)
id<-xls_s1_3$moniker$id
print(spreadsheet_id_to_properties(id))

Gets the name of the spreadsheet provider.

Description

Gets the name of the spreadsheet provider.

Usage

spreadsheet_name()

Value

The name of the spreadsheet provider, to be used in monikers.

Examples

print(spreadsheet_name())

Generates the id corresponding to a list of spreadsheet properties.

Description

Generates the id corresponding to a list of spreadsheet properties.

Usage

spreadsheet_properties_to_id(props)

Arguments

Value

The identifier corresponding to the properties.

Examples

set_spreadsheet_paths(system.file("extdata", package = "rjd3providers"))
xls_s1_3 <- spreadsheet_series("Insee.xlsx", 1, 3)
id<-xls_s1_3$moniker$id
source<-spreadsheet_name()
props<-spreadsheet_id_to_properties(xls_s1_3$moniker$id)
props$gathering$period<-4
props$gathering$aggregation<-"Max"
M<-rjd3toolkit::to_ts(spreadsheet_name(), spreadsheet_properties_to_id(props))
props$gathering$aggregation<-"Min"
m<-rjd3toolkit::to_ts(spreadsheet_name(), spreadsheet_properties_to_id(props))
ts.plot(ts.union(M$data,m$data), col=c("red", "blue"))

Retrieves a time series from a spreadsheet file.

Description

Retrieves a time series from a spreadsheet file.

Usage

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

Arguments

Value

Returns the specified time series.

Examples

set_spreadsheet_paths(system.file("extdata", package = "rjd3providers"))
xls_s1_3 <- spreadsheet_series("Insee.xlsx", 1, 3)
txt_s1 <- spreadsheet_series("Insee.xlsx", "FRANCE Textile", 1)

Change the file of a text moniker

Description

Change the file of a text moniker

Usage

txt_change_file(id, nfile, ofile = NULL)

Arguments

Value

The new identifier

Examples

set_txt_paths(system.file("extdata", package = "rjd3providers"))
txt_15 <- txt_series("ABS.csv", series = 15, delimiter = "COMMA")
id<-txt_15$moniker$id
txt_change_file(id, "test.csv")

Provides the content of a text file designed for time series

Description

Provides the content of a text file designed for time series

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.cleanMissing = TRUE,
  charset = NULL,
  delimiter = c("TAB", "SEMICOLON", "COMMA", "SPACE"),
  txtQualifier = c("NONE", "QUOTE", "DOUBLE_QUOTE"),
  header = TRUE,
  skip = 0
)

Arguments

Value

Provides all the names of the time series contained in the text file

Examples

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

Retrieves all the time series in a text file (.txt, .csv...)

Description

Retrieves all the time series in a text file (.txt, .csv...)

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.cleanMissing = TRUE,
  charset = NULL,
  delimiter = c("TAB", "SEMICOLON", "COMMA", "SPACE"),
  txtQualifier = c("NONE", "QUOTE", "DOUBLE_QUOTE"),
  header = TRUE,
  skip = 0
)

Arguments

Value

A ts collection with all the series

Examples

set_txt_paths(system.file("extdata", 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_to_properties(id)

Arguments

Value

Returns a list with the elements of the id: file [, series], format, gathering, ...).

Examples

set_txt_paths(system.file("extdata", package = "rjd3providers"))
txt_15 <- txt_series("ABS.csv", series = 15, delimiter = "COMMA")
id<-txt_15$moniker$id
print(txt_id_to_properties(id))

Gets the name of the text provider

Description

Gets the name of the text provider

Usage

txt_name()

Value

The name of the text provider, to be used in monikers

Examples

txt_name()

Generates the id corresponding to a list of a text properties.

Description

Generates the id corresponding to a list of a text properties.

Usage

txt_properties_to_id(props)

Arguments

Value

The identifier corresponding to the properties.

Examples

set_txt_paths(system.file("extdata", package = "rjd3providers"))
txt_15 <- txt_series("ABS.csv", series = 15, delimiter = "COMMA")
id<-txt_15$moniker$id
source<-txt_name()
props<-txt_id_to_properties(id)
props$gathering$period<-4
props$gathering$aggregation<-"Max"
M<-rjd3toolkit::to_ts(txt_name(), txt_properties_to_id(props))
props$gathering$aggregation<-"Min"
m<-rjd3toolkit::to_ts(txt_name(), txt_properties_to_id(props))
ts.plot(ts.union(M$data,m$data), col=c("red", "blue"))

Retrieves a time series from a a text file (.txt, .csv...)

Description

Retrieves a time series from a a text file (.txt, .csv...)

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.cleanMissing = TRUE,
  charset = NULL,
  delimiter = c("TAB", "SEMICOLON", "COMMA", "SPACE"),
  txtQualifier = c("NONE", "QUOTE", "DOUBLE_QUOTE"),
  header = TRUE,
  skip = 0
)

Arguments

Value

Returns the specified time series

Examples

set_txt_paths(system.file("extdata", package = "rjd3providers"))
txt_15 <- txt_series("ABS.csv", series = 15, delimiter = "COMMA")
txt_09 <- txt_series("ABS.csv", series = "0.2.09.10.M", delimiter = "COMMA")

Change the file of an xml moniker.

Description

Change the file of an xml moniker.

Usage

xml_change_file(id, nfile, ofile = NULL)

Arguments

Value

The new identifier.

Examples

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

Provides the content of an xml file designed for time series.

Description

Provides the content of an xml file designed for time series.

Usage

xml_content(file, charset = NULL)

Arguments

Value

Provides all the names of the time series contained in the file, grouped by collection.

Examples

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

Retrieves all the time series in a specified collection from an xml file.

Description

Retrieves all the time series in a specified collection from an xml file.

Usage

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

Arguments

Value

A ts collection with all the series.

Examples

set_xml_paths(system.file("extdata", package = "rjd3providers"))
xml_1 <- xml_data("Prod.xml", 1, charset = "iso-8859-1")
xml_all <- xml_data("Prod.xml", "industrial production", 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_to_properties(id)

Arguments

Value

Returns a list with the elements of the id: file, collection[, series], charset, fullnames.

Examples

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

Gets the name of the xml provider.

Description

Gets the name of the xml provider.

Usage

xml_name()

Value

The name of the xml provider, to be used in monikers.

Examples

xml_name()

Generates the id corresponding to a list of an xml properties.

Description

Generates the id corresponding to a list of an xml properties.

Usage

xml_properties_to_id(props)

Arguments

Value

The identifier corresponding to the properties.

Examples

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

Retrieves a time series from an xml file

Description

Retrieves a time series from an xml file

Usage

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

Arguments

Value

Returns the specified time series

Examples

set_xml_paths(system.file("extdata", package = "rjd3providers"))
xml_1_5 <- xml_series("Prod.xml", 1, 5, charset = "iso-8859-1")
xml_cn <- xml_series("Prod.xml", "industrial production",
            "Construction navale", charset = "iso-8859-1")