diff --git a/.Rbuildignore b/.Rbuildignore index 29cf7df..8b29a6e 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -4,3 +4,4 @@ ^pkgdown$ ^.*\.Rproj$ ^\.Rproj\.user$ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..a7276e8 --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,48 @@ +# 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 + +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 335fa10..e39b970 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -10,3 +10,4 @@ License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.3.1 +URL: https://j-miszczyszyn.github.io/KZZLcharts/ diff --git a/README.Rmd b/README.Rmd index c92f103..5e7a639 100644 --- a/README.Rmd +++ b/README.Rmd @@ -3,7 +3,7 @@ output: github_document --- - + \# ```{r, include = FALSE} knitr::opts_chunk$set( collapse = TRUE, @@ -25,31 +25,7 @@ The goal of KZZLcharts is to ... You can install the development version of KZZLcharts from [GitHub](https://github.com/) with: ``` r -# install.packages("devtools") -devtools::install_github("j-miszczyszyn/KZZLcharts") -``` - -## Example - -This is a basic example which shows you how to solve a common problem: - -```{r example} -library(KZZLcharts) -## basic example code -``` - -What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so: - -```{r cars} -summary(cars) -``` - -You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this. - -You can also embed plots, for example: - -```{r pressure, echo = FALSE} -plot(pressure) + + ``` -In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN. diff --git a/README.html b/README.html deleted file mode 100644 index 24c9b83..0000000 --- a/README.html +++ /dev/null @@ -1,421 +0,0 @@ - - - - - - - - - - - - - -README - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - -
-

KZZLcharts

-

-#

-

The goal of KZZLcharts is to …

-
-

Installation

-

You can install the development version of KZZLcharts from GitHub with:

-
# install.packages("devtools")
-devtools::install_github("j-miszczyszyn/KZZLcharts")
-
-
-

Example

-

This is a basic example which shows you how to solve a common -problem:

-
library(KZZLcharts)
-## basic example code
-
-
- - - - -
- - - - - - - - - - - - - - - diff --git a/README.md b/README.md index 024fdff..81243c2 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,21 @@ + + + \# + # KZZLcharts - \# + -The goal of KZZLcharts is to ... +The goal of KZZLcharts is to … ## Installation -You can install the development version of KZZLcharts from [GitHub](https://github.com/) with: +You can install the development version of KZZLcharts from +[GitHub](https://github.com/) with: ``` r -# install.packages("devtools") -devtools::install_github("j-miszczyszyn/KZZLcharts") + + ``` - -## Example - -This is a basic example which shows you how to solve a common problem: - -``` r -library(KZZLcharts) -## basic example code -``` - diff --git a/_pkgdown.yml b/_pkgdown.yml index d71acfb..e8931e8 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,4 +1,4 @@ -url: ~ +url: https://j-miszczyszyn.github.io/KZZLcharts/ template: bootstrap: 5 diff --git a/man/figures/README-pressure-1.png b/man/figures/README-pressure-1.png new file mode 100644 index 0000000..c092055 Binary files /dev/null and b/man/figures/README-pressure-1.png differ