From 2b850107412be2c61ff2608c582e61a178abfd17 Mon Sep 17 00:00:00 2001 From: Sam El-Kamand Date: Tue, 22 Oct 2024 09:23:19 +1100 Subject: [PATCH 1/2] docs: added badges and gallery link to top --- README.Rmd | 7 ++++++- README.md | 12 +++++++++--- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/README.Rmd b/README.Rmd index cc959fd..ecd8b8f 100644 --- a/README.Rmd +++ b/README.Rmd @@ -20,6 +20,9 @@ knitr::opts_chunk$set( [![CRAN status](https://www.r-pkg.org/badges/version/gg1d)](https://CRAN.R-project.org/package=gg1d) [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![Codecov test coverage](https://codecov.io/gh/selkamand/gg1d/branch/master/graph/badge.svg)](https://app.codecov.io/gh/selkamand/gg1d?branch=master) +![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-closed/user/package) +[![code size](https://img.shields.io/github/languages/code-size/user/package.svg)](https://github.com/selkamand/package) +![GitHub last commit](https://img.shields.io/github/last-commit/user/package) Effortlessly visualize all columns in a data frame with gg1d's vertically aligned plots and automatic plot selection based on variable type. @@ -47,6 +50,8 @@ devtools::install_github("selkamand/gg1d") ## Quick Start +For examples of interactive gg1d plots see the [gg1d gallery](https://selkamand.github.io/gg1d/articles/gallery.html) + ```{r, example, fig.width = 7, fig.height = 5} # Load library library(gg1d) @@ -82,4 +87,4 @@ gg1d( ) ``` -For more examples see the [gg1d gallery](https://selkamand.github.io/gg1d/articles/gallery.html) + diff --git a/README.md b/README.md index 5565d34..a9cc1c4 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,12 @@ status](https://www.r-pkg.org/badges/version/gg1d)](https://CRAN.R-project.org/p experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![Codecov test coverage](https://codecov.io/gh/selkamand/gg1d/branch/master/graph/badge.svg)](https://app.codecov.io/gh/selkamand/gg1d?branch=master) +![GitHub Issues or Pull +Requests](https://img.shields.io/github/issues-closed/user/package) +[![code +size](https://img.shields.io/github/languages/code-size/user/package.svg)](https://github.com/selkamand/package) +![GitHub last +commit](https://img.shields.io/github/last-commit/user/package) Effortlessly visualize all columns in a data frame with gg1dā€™s @@ -46,6 +52,9 @@ devtools::install_github("selkamand/gg1d") ## Quick Start +For examples of interactive gg1d plots see the [gg1d +gallery](https://selkamand.github.io/gg1d/articles/gallery.html) + ``` r # Load library library(gg1d) @@ -84,6 +93,3 @@ gg1d( ``` - -For more examples see the [gg1d -gallery](https://selkamand.github.io/gg1d/articles/gallery.html) From 00ce89fa24e57a4fd27578f6b27f4fd35d01e12e Mon Sep 17 00:00:00 2001 From: Sam El-Kamand Date: Tue, 22 Oct 2024 09:28:01 +1100 Subject: [PATCH 2/2] ci: added pkgdown pages --- .github/workflows/pkgdown.yaml | 50 ++++++++++++++++++++++++++++++++++ DESCRIPTION | 2 +- 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/pkgdown.yaml diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..4bbce75 --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,50 @@ +# 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, master] + pull_request: + branches: [main, master] + release: + types: [published] + workflow_dispatch: + +name: pkgdown.yaml + +permissions: read-all + +jobs: + pkgdown: + runs-on: ubuntu-latest + # Only restrict concurrency for non-PR jobs + concurrency: + group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::pkgdown, local::. + needs: website + + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) + shell: Rscript {0} + + - name: Deploy to GitHub pages šŸš€ + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/DESCRIPTION b/DESCRIPTION index 8855296..1a60fe5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -9,7 +9,7 @@ License: MIT + file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.3.1 -URL: https://github.com/selkamand/gg1d +URL: https://github.com/selkamand/gg1d, https://selkamand.github.io/gg1d/ BugReports: https://github.com/selkamand/gg1d/issues Imports: assertions,