From 01c1c8ed2d0b3305856ae10e40d59f8bf13d6515 Mon Sep 17 00:00:00 2001 From: pvictor Date: Fri, 17 Sep 2021 11:24:35 +0200 Subject: [PATCH] maj readme and news --- NEWS.md | 4 +++- README.md | 37 +++++++++++++++++++++++++++++-------- cran-comments.md | 4 ++-- 3 files changed, 34 insertions(+), 11 deletions(-) diff --git a/NEWS.md b/NEWS.md index 17f5d71..426a9a2 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,7 +1,9 @@ apexcharter 0.2.1 ================== -* Updated ApexCharts.js to 3.26.3 +* Updated ApexCharts.js to 3.28.3 +* Internal: use [{packer}](https://github.com/JohnCoene/packer) to manage JavaScript assets. +* `d3.format` JavaScript functions are now available in browser under `format()` and `formatLocale()`. diff --git a/README.md b/README.md index 520f7cd..79cc250 100644 --- a/README.md +++ b/README.md @@ -10,23 +10,20 @@ -:warning: Use RStudio >= 1.2 to properly display charts - - ## Installation -Install from CRAN with: +Install from [CRAN](https://cran.r-project.org/web/packages/apexcharter/index.html) with: ```r install.packages("apexcharter") ``` -Or install the development version from [GitHub](https://github.com/) with: +Or install the development version from [GitHub](https://github.com/dreamRs/apexcharter) with: -``` r -# install.packages("devtools") -devtools::install_github("dreamRs/apexcharter") +```r +# install.packages("remotes") +remotes::install_github("dreamRs/apexcharter") ``` @@ -141,3 +138,27 @@ apexchart(ax_opts = list( ![](man/figures/raw-api.png) + + +## Development + +This package use [{packer}](https://github.com/JohnCoene/packer) to manage JavaScript assets, see packer's [documentation](https://packer.john-coene.com/#/) for more. + +Install nodes modules with: + +```r +packer::npm_install() +``` + +Modify `srcjs/widgets/apexcharter.js`, then run: + +```r +packer::bundle() +``` + +Re-install R package and try `apexcharter()` or `apex()` functions. + + + + + diff --git a/cran-comments.md b/cran-comments.md index dffcd69..d68d421 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,6 +1,6 @@ ## Test environments -* local OS Widows 10 install, R 4.0.3 -* ubuntu 16.04, Windows 10, macOS (on GitHub Actions), R 4.0.5 +* local OS Widows 10 install, R 4.1.0 +* ubuntu 20.04, Windows 10, macOS (on GitHub Actions), R 4.1.1 * win-builder (devel and release) ## R CMD check results