diff --git a/README.Rmd b/README.Rmd index ed85510a..41660b1a 100644 --- a/README.Rmd +++ b/README.Rmd @@ -33,6 +33,8 @@ If you'd like to learn how to use the fastcpd effectively, please refer to: * [Sequential Gradient Descent and Quasi-Newton's Method for Change-Point Analysis](https://proceedings.mlr.press/v206/zhang23b.html) +[documentation & examples](https://fastcpd.xingchi.li/reference/fastcpd.html#ref-examples) + ## Installation ```{r eval = FALSE} @@ -41,20 +43,19 @@ install.packages("fastcpd") ``` ```{r eval = FALSE} -# Install the development version from GitHub -# install.packages("pak") -pak::pak("doccstat/fastcpd") -``` +# Install the development version from GitHub using either of the following +# commands: -If you're compiling from source, you can run -`pak::pkg_system_requirements("fastcpd")`, to see the complete set of system -packages needed on your machine. +## install.packages("pak") +pak::pak("doccstat/fastcpd") -[documentation & examples](https://fastcpd.xingchi.li/reference/fastcpd.html#ref-examples) +## install.packages("devtools") +devtools::install_github("doccstat/fastcpd") +``` ## Dependency -`library(fastcpd)` will load the following packages: +`library(fastcpd)` depends on the following packages: * [Rcpp](https://github.com/RcppCore/Rcpp), for C++ source code compilation. * [RcppArmadillo](https://github.com/RcppCore/RcppArmadillo), for fast linear algebra. @@ -63,6 +64,13 @@ packages needed on your machine. * [glmnet](https://glmnet.stanford.edu/), for penalized regression. * [ggplot2](https://github.com/tidyverse/ggplot2), for data visualization. +If you're compiling from source, you can run the following command to see the +complete set of system packages needed on your machine. + +```{r eval = TRUE} +pak::pkg_sysreqs("doccstat/fastcpd") +``` + ## Contact us Encountered a bug or unintended behavior? diff --git a/README.md b/README.md index cbbda2fc..1fefe983 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,9 @@ to: Change-Point Analysis](https://proceedings.mlr.press/v206/zhang23b.html) +[documentation & +examples](https://fastcpd.xingchi.li/reference/fastcpd.html#ref-examples) + ## Installation ``` r @@ -36,21 +39,19 @@ install.packages("fastcpd") ``` ``` r -# Install the development version from GitHub -# install.packages("pak") -pak::pak("doccstat/fastcpd") -``` +# Install the development version from GitHub using either of the following +# commands: -If you’re compiling from source, you can run -`pak::pkg_system_requirements("fastcpd")`, to see the complete set of -system packages needed on your machine. +## install.packages("pak") +pak::pak("doccstat/fastcpd") -[documentation & -examples](https://fastcpd.xingchi.li/reference/fastcpd.html#ref-examples) +## install.packages("devtools") +devtools::install_github("doccstat/fastcpd") +``` ## Dependency -`library(fastcpd)` will load the following packages: +`library(fastcpd)` depends on the following packages: - [Rcpp](https://github.com/RcppCore/Rcpp), for C++ source code compilation. @@ -64,6 +65,25 @@ examples](https://fastcpd.xingchi.li/reference/fastcpd.html#ref-examples) - [ggplot2](https://github.com/tidyverse/ggplot2), for data visualization. +If you’re compiling from source, you can run the following command to +see the complete set of system packages needed on your machine. + +``` r +pak::pkg_sysreqs("doccstat/fastcpd") +#> ℹ Loading metadata database +#> ✔ Loading metadata database ... done +#> +#> ── Install scripts ───────────────────────────────────────────── Ubuntu 20.04 ── +#> apt-get -y update +#> apt-get -y install libcurl4-openssl-dev libssl-dev zlib1g-dev make +#> +#> ── Packages and their system dependencies ────────────────────────────────────── +#> curl – libcurl4-openssl-dev, libssl-dev +#> data.table – zlib1g-dev +#> fs – make +#> openssl – libssl-dev +``` + ## Contact us Encountered a bug or unintended behavior?