Skip to content

Commit

Permalink
doc via github actions
Browse files Browse the repository at this point in the history
kwstat committed Jul 17, 2024
1 parent 1a2742d commit d788cdf
Showing 58 changed files with 105 additions and 3,412 deletions.
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
50 changes: 50 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -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

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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -20,3 +20,4 @@ vignettes/*.tex
tests/testthat/Rplots.pdf
revdep
pkgdown
docs
25 changes: 14 additions & 11 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
Type: Package
Package: corrgram
Title: Plot a Correlogram
Version: 1.14
Authors@R: person("Kevin","Wright", email="kw.stat@gmail.com", comment=c(ORCID = "0000-0002-0617-8673"), role=c("aut","cre","cph"))
Date: 2021-04-29
Type: Package
Authors@R:
person("Kevin", "Wright", , "kw.stat@gmail.com", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0002-0617-8673"))
Description: Calculates correlation of variables and displays the results
graphically. Included panel functions can display points, shading, ellipses, and
correlation values with confidence intervals. See Friendly (2002) <doi:10.1198/000313002533>.
graphically. Included panel functions can display points, shading,
ellipses, and correlation values with confidence intervals. See
Friendly (2002) <doi:10.1198/000313002533>.
License: MIT + file LICENSE
URL: https://kwstat.github.io/corrgram/, http://kwstat.github.io/corrgram/
BugReports: https://github.com/kwstat/corrgram/issues/
Imports:
graphics,
grDevices,
@@ -20,11 +26,8 @@ Suggests:
seriation,
sfsmisc,
testthat
License: MIT + file LICENSE
LazyData: true
>>>>>>> Stashed changes
VignetteBuilder:
knitr
Encoding: UTF-8
URL: https://kwstat.github.io/corrgram/
BugReports: https://github.com/kwstat/corrgram/issues/
VignetteBuilder: knitr
RoxygenNote: 7.2.3
LazyData: true
RoxygenNote: 7.3.2
53 changes: 35 additions & 18 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# corrgram 1.15 - unpublished
# corrgram 1.15 unpublished

* Switch to MIT license

# corrgram 1.14 - Apr 2021

# corrgram 1.14 (2021-04-01)

* The `seriation` package is moved from Imports to Suggests. This makes `corrgram` lighter loading for most people. (Requested by P.Kiener and others)

* The `outer.labels` argument has improved default values.

# corrgram 1.13 - Jul 2018

# corrgram 1.13 (2018-07-09)

* Test coverage at 95% using `covr` package.

@@ -18,69 +20,80 @@

* `panel.conf` now only allows `cor.method="pearson"` (which is the default.) Fix issue #13.

# corrgram 1.12 - May 2017

# corrgram 1.12 (2017-05-07)

* New vignette about an invalid correlation matrix.

* `corrgram()` gives a better warning if a symmetric matrix has values outside [-1,1].

* Added package logo on github.

# corrgram 1.11 - Apr 2017

# corrgram 1.11 (2017-04-03)

* New argument `outer.labels` for adding labels along outside edges of corrgram. (Request of Vanessa Bruat and others.)

# corrgram 1.10 - Nov 2016

# corrgram 1.10 (2016-11-09)

* Function `corrgram()` now returns the correlation matrix.

* Fixed custom label ordering when `order=TRUE` for M.Bruneaux.

* Began using `testthat` package.

# corrgram 1.9 - Jul 2016

# corrgram 1.9 (2016-07-16)

* New panel function `panel.cor` for colored correlation values.

* Fixed minor bugs with no complete cases.

* Added more cases to tests directory.

# corrgram 1.8 - Jul 2015

# corrgram 1.8 (2015-07-03)

* Namespace changes due to R devel changes.

# corrgram 1.7 - Feb 2015

# corrgram 1.7 (2015-02-13)

* Added more seriate options.

# corrgram 1.6 - Aug 2014

# corrgram 1.6 (2014-08-29)

* Moved packages from Depends to Imports.

* Argument `label.pos` now defaults to c(.5, .5) for x,y positioning. (Request of Evan Williams).

* New argument `cor.method`. (Request of Evan Williams).

# corrgram 1.5 - Aug 2013

# corrgram 1.5 (2013-08-29)

* Updated references links. (Request of Michael Friendly).

* Fixed small bug with test for correlation matrix. (Reported by F. Rosa)

# corrgram 1.4 - Nov 2012

# corrgram 1.4 (2012-11-07)

* New argument `col.regions` to specify panel colors.

* Re-worked examples section for more variety.

# corrgram 1.3 - Aug 2012

# corrgram 1.3 (2012-08-15)

* New panel function `panel.bar`. (Request of dadrivr)

* Added example for unclipped labels (in the test suite).

# corrgram 1.2 - Mar 2012

# corrgram 1.2 (2012-03-28)

* Small bug. Now accepts NA values in correlation matrices, and NAs caused by missing combinations of data and cor(use="pair").

@@ -90,11 +103,13 @@

* Test suite now includes corrgram of inverse correlation, partial correlation matrices.

# corrgram 1.1 - Oct 2011

# corrgram 1.1 (2011-10-20)

* Added namespace.

# corrgram 1.0 - Jul 2011

# corrgram 1.0 (2011-07-02)

* New panel function `panel.conf`.

@@ -108,10 +123,12 @@

* Ordering can now be done on absolute value of correlations.

# corrgram 0.1 - Dec 2006

# corrgram 0.1 (2006-12-01)

* First release to CRAN.

# corrgram 0.0 - Apr 2006

# corrgram 0.0 (2006-04-01)

* Package development begins.
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: http://kwstat.github.io/corrgram/
template:
bootstrap: 5

157 changes: 0 additions & 157 deletions docs/404.html

This file was deleted.

Binary file removed docs/apple-touch-icon-120x120.png
Binary file not shown.
Binary file removed docs/apple-touch-icon-152x152.png
Binary file not shown.
Binary file removed docs/apple-touch-icon-60x60.png
Binary file not shown.
Binary file removed docs/apple-touch-icon-76x76.png
Binary file not shown.
Binary file removed docs/apple-touch-icon.png
Binary file not shown.
190 changes: 0 additions & 190 deletions docs/articles/corrgram_cov2cor.html

This file was deleted.

Binary file not shown.
393 changes: 0 additions & 393 deletions docs/articles/corrgram_examples.html

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
162 changes: 0 additions & 162 deletions docs/articles/index.html

This file was deleted.

162 changes: 0 additions & 162 deletions docs/authors.html

This file was deleted.

148 changes: 0 additions & 148 deletions docs/docsearch.css

This file was deleted.

85 changes: 0 additions & 85 deletions docs/docsearch.js

This file was deleted.

Binary file removed docs/favicon-16x16.png
Binary file not shown.
Binary file removed docs/favicon-32x32.png
Binary file not shown.
Binary file removed docs/favicon.ico
Binary file not shown.
172 changes: 0 additions & 172 deletions docs/index.html

This file was deleted.

12 changes: 0 additions & 12 deletions docs/link.svg

This file was deleted.

Binary file removed docs/logo.png
Binary file not shown.
339 changes: 0 additions & 339 deletions docs/news/index.html

This file was deleted.

256 changes: 0 additions & 256 deletions docs/pkgdown.css

This file was deleted.

113 changes: 0 additions & 113 deletions docs/pkgdown.js

This file was deleted.

7 changes: 0 additions & 7 deletions docs/pkgdown.yml

This file was deleted.

Binary file removed docs/reference/auto-1.png
Binary file not shown.
210 changes: 0 additions & 210 deletions docs/reference/auto.html

This file was deleted.

Binary file removed docs/reference/baseball-1.png
Binary file not shown.
232 changes: 0 additions & 232 deletions docs/reference/baseball.html

This file was deleted.

Binary file removed docs/reference/corrgram-1.png
Diff not rendered.
Binary file removed docs/reference/corrgram-2.png
Diff not rendered.
Binary file removed docs/reference/corrgram-3.png
Diff not rendered.
Binary file removed docs/reference/corrgram-4.png
Diff not rendered.
Binary file removed docs/reference/corrgram-5.png
Diff not rendered.
Loading

0 comments on commit d788cdf

Please sign in to comment.