Skip to content

Commit

Permalink
Add r-universe installation code in README
Browse files Browse the repository at this point in the history
  • Loading branch information
TanguyBarthelemy committed Jul 9, 2024
1 parent 587a7e3 commit f912311
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 5 deletions.
16 changes: 15 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,28 @@ A specification can be created with `rjd3x13::regarima_spec()`, `rjd3x13::x11_sp

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")
remotes::install_github("rjdverse/rjd3x13@*release")
```

To get the current development version from GitHub:
- From [r-universe](https://rjdverse.r-universe.dev/rjd3x13):

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

### Development version

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

```{r, echo = TRUE, eval = FALSE}
# install.packages("remotes")
Expand Down
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,28 @@ 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
# install.packages("remotes")
remotes::install_github("rjdverse/rjd3toolkit@*release")
remotes::install_github("rjdverse/rjd3x13@*release")
```

To get the current development version from GitHub:
- From [r-universe](https://rjdverse.r-universe.dev/rjd3x13):

``` r
install.packages("rjd3x13", repos = c("https://rjdverse.r-universe.dev", "https://cloud.r-project.org"))
```

### Development version

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

``` r
# install.packages("remotes")
Expand Down Expand Up @@ -87,9 +101,6 @@ summary(x13_model$result$preprocessing) # Summary of regarima model
#> Loglikelihood: 746.7517, Adjusted loglikelihood: -2120.875
#> Standard error of the regression (ML estimate): 0.03927991
#> AIC: 4259.75 , AICc: 4260.198 , BIC: 4295.939
```

``` r

plot(x13_model) # Plot of the final decomposition
```
Expand Down
Binary file modified man/figures/README-x-13-final-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f912311

Please sign in to comment.