Data

Tools

Indexes

Applications

Experiments

Open Source Science

rjd3toolkit

Utility package for R access to JDemetra+ version 3.x algorithms

https://github.com/rjdverse/rjd3toolkit

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (19.9%) to scientific vocabulary

Keywords

java jdemetra r r-package rstats seasonal-adjustment time-series timeseries
Last synced: 4 months ago · JSON representation ·

Repository

Utility package for R access to JDemetra+ version 3.x algorithms

Basic Info
Statistics
  • Stars: 9
  • Watchers: 6
  • Forks: 9
  • Open Issues: 12
  • Releases: 9
Topics
java jdemetra r r-package rstats seasonal-adjustment time-series timeseries
Created over 2 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.Rmd 

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
    collapse = TRUE,
    comment = "#>",
    fig.path = "man/figures/README-",
    out.width = "100%"
)
```


# `rjd3toolkit` 


[![CRAN status](https://www.r-pkg.org/badges/version/rjd3toolkit)](https://CRAN.R-project.org/package=rjd3toolkit)
[![Mentioned in Awesome Official Statistics ](https://awesome.re/mentioned-badge.svg)](https://github.com/SNStatComp/awesome-official-statistics-software)

[![R-CMD-check](https://github.com/rjdverse/rjd3toolkit/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rjdverse/rjd3toolkit/actions/workflows/R-CMD-check.yaml)
[![lint](https://github.com/rjdverse/rjd3toolkit/actions/workflows/lint.yaml/badge.svg)](https://github.com/rjdverse/rjd3toolkit/actions/workflows/lint.yaml)

[![GH Pages built](https://github.com/rjdverse/rjd3toolkit/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/rjdverse/rjd3toolkit/actions/workflows/pkgdown.yaml)



Utility package in JDemetra+ 3.x R ecosystem. Contains functions used in other `rjd3` packages and has to be systematically installed before using any other rjd3 package. 

## Main Functions 

-   customize specifications in rjd3x13 and rjd3tramoseats

-   generate user-defined regressors for calendar correction

-   generate auxiliary variables (outliers, ramps..)

-   run arima model estimations

-   perform tests (seasonality, normality, independence)

-   access general functions such as auto-correlations, distributions


## Installation

Running rjd3 packages requires **Java 17 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/rjd3toolkit@*release")
```

- From [r-universe](https://rjdverse.r-universe.dev/rjd3toolkit):

```{r, echo = TRUE, eval = FALSE}
install.packages("rjd3toolkit", repos = c("https://rjdverse.r-universe.dev", "https://cloud.r-project.org"))
```

### Development version

You can install the development version of **rjd3toolkit** from [GitHub](https://github.com/) with:

```{r, echo = TRUE, eval = FALSE}
# install.packages("remotes")
remotes::install_github("rjdverse/rjd3toolkit")
```


## 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).

Owner

  • Name: rjdverse
  • Login: rjdverse
  • Kind: organization

Citation (CITATION.cff) 

# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "rjd3toolkit" in publications use:'
type: software
title: 'rjd3toolkit: Utility Functions around ''JDemetra+ 3.0'''
version: 3.2.4.9000
abstract: R Interface to 'JDemetra+ 3.x' (<https://github.com/jdemetra>) time series
  analysis software. It provides functions allowing to model time series (create outlier
  regressors, user-defined calendar regressors, UCARIMA models...), to test the presence
  of trading days or seasonal effects and also to set specifications in pre-adjustment
  and benchmarking when using rjd3x13 or rjd3tramoseats.
authors:
- family-names: Palate
  given-names: Jean
  email: palatejean@gmail.com
- family-names: Quartier-la-Tente
  given-names: Alain
  email: alain.quartier@yahoo.fr
  orcid: https://orcid.org/0000-0001-7890-3857
- family-names: Barthelemy
  given-names: Tanguy
  email: tanguy.barthelemy@insee.fr
- family-names: Smyk
  given-names: Anna
  email: anna.smyk@insee.fr
repository-code: https://github.com/rjdverse/rjd3toolkit
url: https://rjdverse.github.io/rjd3toolkit/
contact:
- family-names: Barthelemy
  given-names: Tanguy
  email: tanguy.barthelemy@insee.fr
keywords:
- jdemetra
- package
- r
- r-package
- rstats
- seasonal-adjustment
- timeseries
references:
- type: software
  title: 'R: A Language and Environment for Statistical Computing'
  notes: Depends
  url: https://www.R-project.org/
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2024'
  version: '>= 4.1.0'
- type: software
  title: checkmate
  abstract: 'checkmate: Fast and Versatile Argument Checks'
  notes: Imports
  url: https://mllg.github.io/checkmate/
  repository: https://CRAN.R-project.org/package=checkmate
  authors:
  - family-names: Lang
    given-names: Michel
    email: michellang@gmail.com
    orcid: https://orcid.org/0000-0001-9754-0393
  year: '2024'
  doi: 10.32614/CRAN.package.checkmate
- type: software
  title: graphics
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2024'
- type: software
  title: methods
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2024'
- type: software
  title: rJava
  abstract: 'rJava: Low-Level R to Java Interface'
  notes: Imports
  url: http://www.rforge.net/rJava/
  repository: https://CRAN.R-project.org/package=rJava
  authors:
  - family-names: Urbanek
    given-names: Simon
    email: simon.urbanek@r-project.org
  year: '2024'
  doi: 10.32614/CRAN.package.rJava
  version: '>= 1.0-6'
- type: software
  title: RProtoBuf
  abstract: 'RProtoBuf: R Interface to the ''Protocol Buffers'' ''API'' (Version 2
    or 3)'
  notes: Imports
  url: https://dirk.eddelbuettel.com/code/rprotobuf.html
  repository: https://CRAN.R-project.org/package=RProtoBuf
  authors:
  - family-names: Francois
    given-names: Romain
  - family-names: Eddelbuettel
    given-names: Dirk
  - family-names: Stokely
    given-names: Murray
  - family-names: Ooms
    given-names: Jeroen
  year: '2024'
  doi: 10.32614/CRAN.package.RProtoBuf
  version: '>= 0.4.20'
- type: software
  title: stats
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2024'
- type: software
  title: utils
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2024'
- type: software
  title: spelling
  abstract: 'spelling: Tools for Spell Checking in R'
  notes: Suggests
  url: https://ropensci.r-universe.dev/spelling
  repository: https://CRAN.R-project.org/package=spelling
  authors:
  - family-names: Ooms
    given-names: Jeroen
    email: jeroenooms@gmail.com
    orcid: https://orcid.org/0000-0002-4035-0289
  - family-names: Hester
    given-names: Jim
    email: james.hester@rstudio.com
  year: '2024'
  doi: 10.32614/CRAN.package.spelling

GitHub Events

Total
  • Create event: 4
  • Release event: 4
  • Issues event: 28
  • Watch event: 2
  • Delete event: 2
  • Issue comment event: 38
  • Push event: 76
  • Pull request event: 64
Last Year
  • Create event: 4
  • Release event: 4
  • Issues event: 28
  • Watch event: 2
  • Delete event: 2
  • Issue comment event: 38
  • Push event: 76
  • Pull request event: 64

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 15
  • Total pull requests: 30
  • Average time to close issues: 7 months
  • Average time to close pull requests: about 24 hours
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 0.93
  • Average comments per pull request: 0.17
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 13
  • Pull requests: 30
  • Average time to close issues: 5 months
  • Average time to close pull requests: about 24 hours
  • Issue authors: 4
  • Pull request authors: 3
  • Average comments per issue: 0.77
  • Average comments per pull request: 0.17
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • TanguyBarthelemy (11)
  • AQLT (5)
  • annasmyk (2)
  • lauramartinez09 (1)
  • AdamWallach (1)
Pull Request Authors
  • palatej (23)
  • TanguyBarthelemy (17)
  • AQLT (8)
  • annasmyk (5)
  • carlos-saez (1)
Top Labels
Issue Labels
Pull Request Labels