From 094741aa786ad971daf6273ecc57ec16d0356a36 Mon Sep 17 00:00:00 2001 From: Tanguy BARTHELEMY Date: Tue, 14 May 2024 16:12:57 +0200 Subject: [PATCH 1/2] Prepare for CRAN --- .Rbuildignore | 33 +++-- .github/workflows/R-CMD-check2.yaml | 166 +++++++++++++++++++++++++ .github/workflows/lint.yaml | 2 +- .github/workflows/pr-commands.yaml | 139 +++++++++++++++++++++ .github/workflows/rjava.yaml | 53 ++++++++ .github/workflows/test-coverage.yaml | 57 +++++++++ .gitignore | 53 +++++++- DESCRIPTION | 28 +++-- README.Rmd | 26 ++-- README.md | 31 +++-- _pkgdown.yml | 2 +- docs/404.html | 2 +- docs/authors.html | 2 +- docs/index.html | 4 +- docs/reference/get_comment.html | 2 +- docs/reference/index.html | 2 +- docs/reference/manipulate_sa_item.html | 2 +- docs/reference/replace_series.html | 2 +- docs/reference/set_comment.html | 2 +- docs/reference/set_metadata.html | 2 +- docs/reference/set_name.html | 2 +- docs/reference/set_spec.html | 2 +- docs/reference/set_ts.html | 2 +- docs/reference/update_metadata.html | 2 +- man/figures/logo.png | Bin 0 -> 335614 bytes 25 files changed, 554 insertions(+), 64 deletions(-) create mode 100644 .github/workflows/R-CMD-check2.yaml create mode 100644 .github/workflows/pr-commands.yaml create mode 100644 .github/workflows/rjava.yaml create mode 100644 .github/workflows/test-coverage.yaml create mode 100644 man/figures/logo.png diff --git a/.Rbuildignore b/.Rbuildignore index cd23544..e52e7ec 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,17 +1,30 @@ -^Meta$ -^docs$ -^_pkgdown\.yml$ + ^.*\.Rproj$ ^\.Rproj\.user$ + +^\.git$ +^\.github$ + ^README\.Rmd$ ^README-.*\.png$ -.travis.yml -^pkgdown$ + +^Meta$ +^docs$ ^doc$ +^pkgdown$ +^_pkgdown\.yml$ + +^\.lintr$ + +^appveyor\.yml$ +.travis.yml + cran-comments.md -^\.github$ -^LICENCE$ -^LICENCE_en$ -TO_DO -.lintr +^\.DS_Store$ + +^revdep$ +^reconf\.sh$ + +^LICENCE$ +^LICENSE$ diff --git a/.github/workflows/R-CMD-check2.yaml b/.github/workflows/R-CMD-check2.yaml new file mode 100644 index 0000000..6c1c547 --- /dev/null +++ b/.github/workflows/R-CMD-check2.yaml @@ -0,0 +1,166 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/master/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + workflow_dispatch + +name: R-CMD-check + +jobs: + R-CMD-check: + runs-on: ${{ matrix.os }} + + name: ${{ matrix.os }} (${{ matrix.r }}) java ${{ matrix.java }} + + strategy: + fail-fast: false + matrix: + # os: [ 'ubuntu-latest', 'windows-latest', 'macOS-latest' ] + # r: [ 'devel', 'release', 'oldrel-1', '4.2.1', '4.1.1', '4.1.3', '4.0.5', '3.6.1' ] + # java: [ '11', '13', '17', '19', '21' ] + os: [ 'windows-latest' ] + r: [ 'devel', 'release' ] + # Pb with Java 8 + java: [ '11' ] + include: + - http-user-agent: 'release' + r: 'devel' + + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + R_KEEP_PKG_SOURCE: yes + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + # Set-up java + + - name: Setup java (x64) + uses: actions/setup-java@v4 + with: + java-version: ${{ matrix.java }} + java-package: jdk + distribution: 'zulu' + architecture: x64 + + - name: Setup java (x86) + uses: actions/setup-java@v4 + with: + java-version: ${{ matrix.java }} + java-package: jdk + distribution: 'zulu' + architecture: x86 + + +# +# - name: Setup java (x64) +# uses: actions/setup-java@v4 +# if: matrix.java != '19' +# with: +# java-version: ${{ matrix.java }} +# java-package: jdk +# distribution: 'zulu' +# architecture: x64 +# +# - name: Setup java 19 (x64) +# uses: actions/setup-java@v4 +# if: matrix.java == '19' +# with: +# java-version: ${{ matrix.java }} +# java-package: jdk +# distribution: 'temurin' +# architecture: x64 +# +# - name: Setup java (x86) +# uses: actions/setup-java@v4 +# if: runner.os == 'Windows' && matrix.java != '19' +# with: +# java-version: ${{ matrix.java }} +# java-package: jdk +# distribution: 'zulu' +# architecture: x86 +# +# - name: Setup java 19 (x86) +# uses: actions/setup-java@v4 +# if: runner.os == 'Windows' && matrix.java == '19' +# with: +# java-version: ${{ matrix.java }} +# java-package: jdk +# distribution: 'temurin' +# architecture: x86 + + # Some additionnal set up for ubuntu + # - name: Installation de libcurl4-openssl-dev + # if: runner.os == 'Linux' + # run: | + # sudo apt-get update + # sudo apt-get install -y libcurl4-openssl-dev + # sudo apt-get install -y default-jre + # sudo find / -name libjvm.so + # + # - name: Définir LD_LIBRARY_PATH + # if: runner.os == 'Linux' + # run: | + # sudo bash -c 'export LD_LIBRARY_PATH=/usr/lib/jvm/temurin-11-jdk-amd64/lib/server:$LD_LIBRARY_PATH' + # sudo bash -c "echo 'export LD_LIBRARY_PATH=/usr/lib/jvm/temurin-11-jdk-amd64/lib/server:$LD_LIBRARY_PATH' >> $HOME/.profile" + # + # - name: Afficher le chemin de bibliothèque Java + # if: runner.os == 'Linux' + # run: echo $LD_LIBRARY_PATH + # + # - name: Vérifier la version de Java + # if: runner.os == 'Linux' + # run: java -version + # + # - name: Vérifier la valeur de JAVA_HOME + # if: runner.os == 'Linux' + # run: echo $JAVA_HOME + + # Set up R + - uses: r-lib/actions/setup-r@v2 + with: + r-version: ${{ matrix.r }} + http-user-agent: ${{ matrix.http-user-agent }} + use-public-rspm: true + + # Pour MacOS et ubuntu, qqs installation supplémentaires + - name: "[Stage] [macOS] Install libgit2" + if: runner.os == 'macOS' + run: brew install libgit2 + + - name: "[Stage] [macOS] Install system libs for pkgdown" + if: runner.os == 'macOS' + run: brew install harfbuzz fribidi + + - name: "Configure java pour ubuntu et macos" + if: runner.os != 'Windows' + run: sudo R CMD javareconf + + - name: "[macOS] Install textshaping" + run: install.packages('textshaping') + shell: Rscript {0} + if: ${{ runner.os == 'macOS' && matrix.r == 'devel' }} + + - name: "[macOS] Install systemfonts" + run: install.packages('systemfonts') + shell: Rscript {0} + if: ${{ runner.os == 'macOS' && matrix.r == '3.6.1' }} + + # Dépendances + + - uses: r-lib/actions/setup-r-dependencies@v2 + if: ${{ matrix.r != '3.6.1' }} + with: + packages: knitr, kableExtra, rmarkdown + extra-packages: any::rcmdcheck + + # Pour R 3.6.1 qqs installations supplémentaires + - name: "[R 3.6.1] Install dependency" + run: install.packages(c("rJava", "XML", "RJDemetra", "rcmdcheck")) + shell: Rscript {0} + if: ${{ matrix.r == '3.6.1' || matrix.java == '11' }} + + - uses: r-lib/actions/setup-tinytex@v2 + + - uses: r-lib/actions/check-r-package@v2 diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index f4c4ef2..f60d047 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -14,7 +14,7 @@ jobs: env: GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: r-lib/actions/setup-r@v2 with: diff --git a/.github/workflows/pr-commands.yaml b/.github/workflows/pr-commands.yaml new file mode 100644 index 0000000..f3e77c6 --- /dev/null +++ b/.github/workflows/pr-commands.yaml @@ -0,0 +1,139 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + issue_comment: + types: [created] + +name: Commands + +jobs: + document: + if: ${{ github.event.issue.pull_request && (github.event.comment.author_association == 'MEMBER' || github.event.comment.author_association == 'OWNER') && startsWith(github.event.comment.body, '/document') }} + name: document + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/pr-fetch@v2 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + + - uses: actions/setup-java@v4 + with: + distribution: 'zulu' # See 'Supported distributions' for available options + java-version: '17' + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - name: Set up for RProtoBuf + run: sudo apt-get update -y && sudo apt-get install protobuf-compiler libprotobuf-dev libprotoc-dev + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::roxygen2 + needs: pr-document + + - name: Document + run: roxygen2::roxygenise() + shell: Rscript {0} + + - name: Config git + run: | + git config --local user.name "$GITHUB_ACTOR" + git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com" + + # Check if there are any changes + - name: Check for changes + id: check-changes + run: | + if git diff --quiet -- NAMESPACE man/; then + echo "has-changed=false" >> "$GITHUB_OUTPUT" + else + echo "has-changed=true" >> "$GITHUB_OUTPUT" + fi + + - name: Commit the changes + if: ${{ steps.check-changes.outputs.has-changed == 'true' }} + run: | + git add man/\* NAMESPACE + git commit -m '[GHA] Document package' + + # Commit changes or a placeholder commit if no changes + - name: Commit no changes + if: ${{ steps.check-changes.outputs.has-changed == 'false' }} + run: | + git commit --allow-empty -m '[GHA] Package already documented' + + - uses: r-lib/actions/pr-push@v2 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + + style: + if: ${{ github.event.issue.pull_request && (github.event.comment.author_association == 'MEMBER' || github.event.comment.author_association == 'OWNER') && startsWith(github.event.comment.body, '/style') }} + name: style + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/pr-fetch@v2 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + + - uses: actions/setup-java@v4 + with: + distribution: 'zulu' # See 'Supported distributions' for available options + java-version: '17' + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - name: Set up for RProtoBuf + run: sudo apt-get update -y && sudo apt-get install protobuf-compiler libprotobuf-dev libprotoc-dev + + - name: Install dependencies + run: install.packages("styler") + shell: Rscript {0} + + - name: Style + run: styler::style_pkg(transformers = styler::tidyverse_style(indent_by = 4)) + shell: Rscript {0} + + - name: Config git + run: | + git config --local user.name "$GITHUB_ACTOR" + git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com" + + # Check if there are any changes + - name: Check for changes + id: check-changes + run: | + if git diff --quiet -- '*.R'; then + echo "has-changed=false" >> "$GITHUB_OUTPUT" + else + echo "has-changed=true" >> "$GITHUB_OUTPUT" + fi + + - name: Commit the changes + if: ${{ steps.check-changes.outputs.has-changed == 'true' }} + run: | + git add \*.R + git commit -m '[GHA] Style package' + + # Commit changes or a placeholder commit if no changes + - name: Commit no changes + if: ${{ steps.check-changes.outputs.has-changed == 'false' }} + run: | + git commit --allow-empty -m '[GHA] Package already styled' + + - uses: r-lib/actions/pr-push@v2 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/rjava.yaml b/.github/workflows/rjava.yaml new file mode 100644 index 0000000..e87adcd --- /dev/null +++ b/.github/workflows/rjava.yaml @@ -0,0 +1,53 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/master/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + +name: rjava + +jobs: + R-CMD-check: + runs-on: ${{ matrix.os }} + + name: ${{ matrix.os }} (${{ matrix.r }}) java ${{ matrix.java }} + + strategy: + fail-fast: false + matrix: + # os: [ 'ubuntu-latest', 'windows-latest', 'macOS-latest' ] + # r: [ 'devel', 'release', 'oldrel-1', '4.2.1', '4.1.1', '4.1.3', '4.0.5', '3.6.1' ] + # java: [ '8', '13', '17', '19', '21' ] + os: [ 'ubuntu-latest' ] + r: [ 'devel' ] + java: [ '8' ] + include: + - http-user-agent: 'release' + r: 'devel' + + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + R_KEEP_PKG_SOURCE: yes + + steps: + - uses: actions/checkout@v4 + + # Set-up java + - name: Setup java + uses: actions/setup-java@v4 + with: + java-version: ${{ matrix.java }} + distribution: 'zulu' + + # Set up R + - uses: r-lib/actions/setup-r@v2 + with: + r-version: ${{ matrix.r }} + http-user-agent: ${{ matrix.http-user-agent }} + use-public-rspm: true + + - name: Test rJava installation + run: install.packages("rJava");library("rJava") + shell: Rscript {0} diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml new file mode 100644 index 0000000..d0240ea --- /dev/null +++ b/.github/workflows/test-coverage.yaml @@ -0,0 +1,57 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, develop, master] + pull_request: + branches: [main, develop, master] + +name: test-coverage + +jobs: + test-coverage: + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: actions/setup-java@v4 + with: + distribution: 'zulu' # See 'Supported distributions' for available options + java-version: '17' + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::covr + needs: coverage + + - name: Test coverage + run: | + covr::codecov( + quiet = FALSE, + clean = FALSE, + install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package") + ) + shell: Rscript {0} + + - name: Show testthat output + if: always() + run: | + ## -------------------------------------------------------------------- + find '${{ runner.temp }}/package' -name 'testthat.Rout*' -exec cat '{}' \; || true + shell: bash + + - name: Upload test results + if: failure() + uses: actions/upload-artifact@v4 + with: + name: coverage-test-failures + path: ${{ runner.temp }}/package diff --git a/.gitignore b/.gitignore index fa51dd5..de7c8b2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,55 @@ -.Rproj.user +# History files .Rhistory +.Rapp.history + +# Session Data files .RData +.RDataTmp + +# User-specific files .Ruserdata -TO_DO +# Example code in package build process +*-Ex.R + +# Output files from R CMD build +/*.tar.gz + +# Output files from R CMD check +/*.Rcheck/ + +# RStudio files +.Rproj.user/ + +# produced vignettes +vignettes/*.html +vignettes/*.pdf +Meta/ +inst/doc/ +doc/ + +# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3 +.httr-oauth + +# knitr and R markdown default cache directories +*_cache/ +/cache/ + +# Temporary files created by R markdown +*.utf8.md +*.knit.md + +# R Environment Variables +.Renviron + +# pkgdown site +docs/ + +# translation temp files +po/*~ + +# RStudio Connect folder +rsconnect/ + +# Hidden file from mac-os +.DS_Store diff --git a/DESCRIPTION b/DESCRIPTION index 5fe5662..00f2c1f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,18 +1,22 @@ Package: rjdworkspace Type: Package -Title: Manipulate 'JDemetra+' workspaces +Title: Manipulate 'JDemetra+' Workspaces Version: 1.1.7 -Authors@R: c( - person(given = "Alain", - family = "Quartier-la-Tente", - role = c("aut", "cre"), - email = "alain.quartier@yahoo.fr", - comment = c(ORCID = "0000-0001-7890-3857")), - person(given = "Institut national de la statistique et des études économiques", - role = "cph", - email = c("tanguy.barthelemy@insee.fr","anna.smyk@insee.fr"), - comment = "https://www.insee.fr/")) -Description: Set of tools to manipualte the 'JDemetra+' workspaces. +Authors@R: + c(person(given = "Alain", + family = "Quartier-la-Tente", + role = c("aut"), + email = "alain.quartier-la-tente@insee.fr"), + person(given = "Institut national de la statistique et des études économiques", + role = "cph", + comment = "https://www.insee.fr/"), + person(given = "Tanguy", + family = "Barthelemy", role = c("aut", "cre"), + email ="tanguy.barthelemy@insee.fr"), + person(given = "Anna", + family = "Smyk", role = c("aut"), + email ="anna.smyk@insee.fr")) +Description: Set of tools to manipulate the 'JDemetra+' workspaces. Depends: R (>= 3.1.1) Imports: diff --git a/README.Rmd b/README.Rmd index 0d2c526..ae6ab56 100644 --- a/README.Rmd +++ b/README.Rmd @@ -14,16 +14,20 @@ knitr::opts_chunk$set( ``` -# rjdworskpace +# rjdworskpace -[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rjdworkspace)](https://cran.r-project.org/package=rjdworkspace) + +[![CRAN status](http://www.r-pkg.org/badges/version/rjdworkspace)](https://cran.r-project.org/package=rjdworkspace) [![Linting code](https://github.com/InseeFrLab/rjdworkspace/actions/workflows/lint.yaml/badge.svg)](https://github.com/InseeFrLab/rjdworkspace/actions/workflows/lint.yaml) +[![R-CMD-check](https://github.com/InseeFrLab/rjdworkspace/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/InseeFrLab/rjdworkspace/actions/workflows/R-CMD-check.yaml) + + ## Français 🇫🇷 -### Présentation !! +### Présentation -`rjdworkspace` propose un ensemble d'outils pour manipuler les workspaces de `JDemetra+`. Ce package utilise les archives .jar Java de [`RJDemetra`](https://github.com/nbbrd/rjdemetra) en y ajoutant certaines fonctionnalités. En particulier, `rjdworkspace` permet de : +`rjdworkspace` propose un ensemble d'outils pour manipuler les workspaces de `JDemetra+`. Ce package utilise les archives .jar Java de [`RJDemetra`](https://github.com/rjdverse/rjdemetra) en y ajoutant certaines fonctionnalités. En particulier, `rjdworkspace` permet de : - mettre à jour toutes les metadata d'un workspace avec celles d'un autre (`update_metadata()`, `update_metadata_roughly()`) ou mettre à jour les metadata d'un SaItem avec les metadata d'un autre SaItem (`set_metadata()`) - remplacer, supprimer ou ajouter des séries à un workspace (`remove_sa_item()`, `remove_all_sa_item()`, `replace_sa_item()`, `replace_series()`, `add_new_sa_item()`) @@ -33,7 +37,7 @@ knitr::opts_chunk$set( ### Installation -`rjdworkspace` s'appuie sur [`RJDemetra`](https://github.com/nbbrd/rjdemetra) qui nécessite Java SE 8 ou une version ultérieure. +`rjdworkspace` s'appuie sur [`RJDemetra`](https://github.com/rjdverse/rjdemetra) qui nécessite Java SE 8 ou une version ultérieure. Pour obtenir la dernière release stable du package : @@ -42,7 +46,7 @@ Pour obtenir la dernière release stable du package : # install.packages("remotes") # Installer la dernière version stable disponible sur GitHub -remotes::install_github("InseeFrLab/rjdworkspace@*release") +remotes::install_github("InseeFrLabLab/rjdworkspace@*release") # Sur les ordinateurs Insee install.packages("rjdworkspace", repos = "https://nexus.insee.fr/repository/r-public/") @@ -55,7 +59,7 @@ Pour obtenir la version en cours de développement depuis GitHub : # install.packages("remotes") # Installer la version en cours de développement depuis GitHub -remotes::install_github("InseeFrLab/rjdworkspace") +remotes::install_github("InseeFrLabLab/rjdworkspace") ``` @@ -67,7 +71,7 @@ Pour une description plus complète des packages R pour JDemetra+ voir le docume `rjdworkspace` provides a set of tools designed to manipulate `JDemetra+` workspaces. It depends on the .jar files of -[`RJDemetra`](https://github.com/nbbrd/rjdemetra) and extends some +[`RJDemetra`](https://github.com/rjdverse/rjdemetra) and extends some functions. In particular, `rjdworkspace` allows to: - update all metadata of a workspace with those contained in another @@ -86,7 +90,7 @@ functions. In particular, `rjdworkspace` allows to: ### Installation -`rjdworkspace` relies on [`RJDemetra`](https://github.com/nbbrd/rjdemetra) that requires Java SE 8 or later version. +`rjdworkspace` relies on [`RJDemetra`](https://github.com/rjdverse/rjdemetra) that requires Java SE 8 or later version. To get the current stable version (from the latest release): @@ -95,7 +99,7 @@ To get the current stable version (from the latest release): # install.packages("remotes") # Install the last stable release from GitHub -remotes::install_github("InseeFrLab/rjdworkspace@*release") +remotes::install_github("InseeFrLabLab/rjdworkspace@*release") # on Insee computer install.packages("rjdworkspace", repos = "https://nexus.insee.fr/repository/r-public/") @@ -108,7 +112,7 @@ To get the current development version from GitHub: # install.packages("remotes") # Install development version from GitHub -remotes::install_github("InseeFrLab/rjdworkspace") +remotes::install_github("InseeFrLabLab/rjdworkspace") ``` For a more comprehensive description of the R packages for JDemetra+ check the Insee working paper [R Tools for JDemetra+: Seasonal adjustment made easier](https://www.insee.fr/en/statistiques/5019812) diff --git a/README.md b/README.md index dff5a49..0c31c65 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,24 @@ -# rjdworskpace +# rjdworskpace -[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rjdworkspace)](https://cran.r-project.org/package=rjdworkspace) + + +[![CRAN +status](http://www.r-pkg.org/badges/version/rjdworkspace)](https://cran.r-project.org/package=rjdworkspace) [![Linting code](https://github.com/InseeFrLab/rjdworkspace/actions/workflows/lint.yaml/badge.svg)](https://github.com/InseeFrLab/rjdworkspace/actions/workflows/lint.yaml) +[![R-CMD-check](https://github.com/InseeFrLab/rjdworkspace/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/InseeFrLab/rjdworkspace/actions/workflows/R-CMD-check.yaml) + ## Français 🇫🇷 -### Présentation !! +### Présentation `rjdworkspace` propose un ensemble d’outils pour manipuler les workspaces de `JDemetra+`. Ce package utilise les archives .jar Java de -[`RJDemetra`](https://github.com/nbbrd/rjdemetra) en y ajoutant +[`RJDemetra`](https://github.com/rjdverse/rjdemetra) en y ajoutant certaines fonctionnalités. En particulier, `rjdworkspace` permet de : - mettre à jour toutes les metadata d’un workspace avec celles d’un @@ -33,8 +38,8 @@ certaines fonctionnalités. En particulier, `rjdworkspace` permet de : ### Installation `rjdworkspace` s’appuie sur -[`RJDemetra`](https://github.com/nbbrd/rjdemetra) qui nécessite Java SE -8 ou une version ultérieure. +[`RJDemetra`](https://github.com/rjdverse/rjdemetra) qui nécessite Java +SE 8 ou une version ultérieure. Pour obtenir la dernière release stable du package : @@ -43,7 +48,7 @@ Pour obtenir la dernière release stable du package : # install.packages("remotes") # Installer la dernière version stable disponible sur GitHub -remotes::install_github("InseeFrLab/rjdworkspace@*release") +remotes::install_github("InseeFrLabLab/rjdworkspace@*release") # Sur les ordinateurs Insee install.packages("rjdworkspace", repos = "https://nexus.insee.fr/repository/r-public/") @@ -56,7 +61,7 @@ Pour obtenir la version en cours de développement depuis GitHub : # install.packages("remotes") # Installer la version en cours de développement depuis GitHub -remotes::install_github("InseeFrLab/rjdworkspace") +remotes::install_github("InseeFrLabLab/rjdworkspace") ``` Pour une description plus complète des packages R pour JDemetra+ voir le @@ -69,7 +74,7 @@ désaisonnalisation](https://www.insee.fr/fr/statistiques/5019786) `rjdworkspace` provides a set of tools designed to manipulate `JDemetra+` workspaces. It depends on the .jar files of -[`RJDemetra`](https://github.com/nbbrd/rjdemetra) and extends some +[`RJDemetra`](https://github.com/rjdverse/rjdemetra) and extends some functions. In particular, `rjdworkspace` allows to: - update all metadata of a workspace with those contained in another one @@ -88,8 +93,8 @@ functions. In particular, `rjdworkspace` allows to: ### Installation `rjdworkspace` relies on -[`RJDemetra`](https://github.com/nbbrd/rjdemetra) that requires Java SE -8 or later version. +[`RJDemetra`](https://github.com/rjdverse/rjdemetra) that requires Java +SE 8 or later version. To get the current stable version (from the latest release): @@ -98,7 +103,7 @@ To get the current stable version (from the latest release): # install.packages("remotes") # Install the last stable release from GitHub -remotes::install_github("InseeFrLab/rjdworkspace@*release") +remotes::install_github("InseeFrLabLab/rjdworkspace@*release") # on Insee computer install.packages("rjdworkspace", repos = "https://nexus.insee.fr/repository/r-public/") @@ -111,7 +116,7 @@ To get the current development version from GitHub: # install.packages("remotes") # Install development version from GitHub -remotes::install_github("InseeFrLab/rjdworkspace") +remotes::install_github("InseeFrLabLab/rjdworkspace") ``` For a more comprehensive description of the R packages for JDemetra+ diff --git a/_pkgdown.yml b/_pkgdown.yml index f13482e..4d17a7a 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -29,7 +29,7 @@ navbar: text: Around JDemetra+ and R menu: - text: RJDemetra - href: https://github.com/jdemetra/rjdemetra + href: https://github.com/rjdverse/rjdemetra - text: ggdemetra href: https://github.com/AQLT/ggdemetra - text: rjdqa diff --git a/docs/404.html b/docs/404.html index ca4f4f7..d7eac9f 100644 --- a/docs/404.html +++ b/docs/404.html @@ -108,7 +108,7 @@