-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathREADME.Rmd
More file actions
99 lines (61 loc) · 3.44 KB
/
README.Rmd
File metadata and controls
99 lines (61 loc) · 3.44 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# {rjd3providers} <a href="https://rjdverse.github.io/rjd3providers/"><img src="man/figures/logo.png" align="right" height="150" style="float:right; height:150px;"/></a>
<!-- badges: start -->
[](https://cran.r-project.org/package=rjd3providers)
[](https://github.com/SNStatComp/awesome-official-statistics-software)
[](https://github.com/rjdverse/rjd3providers/actions/workflows/R-CMD-check.yaml)
[](https://github.com/rjdverse/rjd3providers/actions/workflows/lint.yaml)
[](https://github.com/rjdverse/rjd3providers/actions/workflows/pkgdown.yaml)
<!-- badges: end -->
## Overview
**{rjd3providers}** provides tools to explore the default time series providers (.xslx, .csv, .txt and .xml files) for JDemetra+ v3.x Graphical User Interface. It allows to manipulate raw series files. For example, using this R package, you will be able to:
- change the **path** of the raw data
- change the file **type**
- manipulate **monikers**
- change file **read properties**
## Installation
**{rjd3providers}** relies on the [**{rJava}**](https://CRAN.R-project.org/package=rJava) package.
Running rjd3 packages requires **Java 21 or higher**. How to set up such a configuration in R is explained [here](https://jdemetra-new-documentation.netlify.app/#Rconfig)
### Latest release
To get the current stable version (from the latest release):
- From GitHub:
```{r, echo = TRUE, eval = FALSE}
# install.packages("remotes")
remotes::install_github("rjdverse/rjd3providers@*release", build_vignettes = TRUE)
```
- From [r-universe](https://rjdverse.r-universe.dev/rjd3providers):
```{r, echo = TRUE, eval = FALSE}
install.packages("rjd3providers", repos = c("https://rjdverse.r-universe.dev", "https://cloud.r-project.org"))
```
### Development version
You can install the development version of **{rjd3providers}** from [GitHub](https://github.com/) with:
```{r, echo = TRUE, eval = FALSE}
# install.packages("remotes")
remotes::install_github("rjdverse/rjd3providers")
```
## Usage
### Generate all the TS information
``` {r generate_info, echo = TRUE, eval = TRUE}
library("rjd3providers")
xlsx_file <- paste0(system.file("extdata", package = "rjd3providers"), "/Insee.xlsx")
spreadsheet_content(xlsx_file)
ts1 <- spreadsheet_series(file = xlsx_file, sheet = 1L, series = 3)
str(ts1)
all_ts <- spreadsheet_data(file = xlsx_file, sheet = 2L)
```
## Package Maintenance and contributing
Any contribution is welcome and should be done through pull requests and/or issues.
pull requests should include **updated tests** and **updated documentation**. If functionality is changed, docstrings should be added or updated.
## Licensing
The code of this project is licensed under the [European Union Public Licence (EUPL)](https://interoperable-europe.ec.europa.eu:443/collection/eupl/eupl-text-eupl-12).