Skip to content

Commit

Permalink
Added pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
rvlenth committed Jun 9, 2024
1 parent 2727044 commit 1671d61
Show file tree
Hide file tree
Showing 7 changed files with 92 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ README.html
README.md
README_files

^_pkgdown\.yml$
^docs$
^pkgdown$
52 changes: 52 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 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


5 changes: 3 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
Package: unrepx
Type: Package
Title: Analysis and Graphics for Unreplicated Experiments
Version: 1.0-2
Date: 2022-08-11
Version: 1.0-3
Date: 2024-06-09
Authors@R: c(person("Russell", "Lenth", role = c("aut", "cre", "cph"),
email = "russell-lenth@uiowa.edu"))
LazyData: no
URL: https://github.com/rvlenth/unrepx,https://rvlenth.github.io/unrepx/
BugReports: https://github.com/rvlenth/unrepx/issues
Description: Provides half-normal plots, reference plots, and Pareto plots
of effects from an unreplicated experiment, along with various
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
#### Developer/maintainer
Russ Lenth, University of Iowa, `russell-lenth@uiowa.edu`

URL: https://rvlenth.github.io/unrepx/

The **unrepx** package provides much of what one needs to analyze basic unreplicated
screening experiments such as two-level factorial and fractional factorial designs,
in which one has a set of independent effect estimates but no degrees of freedom for
Expand Down
28 changes: 28 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
url: https://rvlenth.github.io/unrepx/
template:
bootstrap: 5

reference:
- title: Package overview
contents:
- unrepx-package

- title: Analysis
contents:
- PSE
- ref.dist
- yates

- title: Graphical assessment
contents:
- dot.plot
- hnplot
- parplot
- refplot
- daniel.paper

- title: Data and examples
contents:
- pdEff


3 changes: 3 additions & 0 deletions inst/NEWS
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
NEWS file for unrepx package

version 1.0-3
Added pkgdown site

version 1.0-2
Workarounds for dot.plot() and refplot() in non-interactive environments
so that the vignette can be built in R 4.3
Expand Down
1 change: 1 addition & 0 deletions vignettes/overview.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "**unrepx** package for R"
subtitle: "Analysis of unreplicated experiments"
author: "Russ Lenth"
date: "Version `r packageVersion('unrepx')` -- `r utils::packageDescription('unrepx')$Date`"
output: emmeans::.emm_vignette
vignette: >
%\VignetteIndexEntry{Overview of the unrepx package}
%\VignetteEngine{knitr::rmarkdown}
Expand Down

0 comments on commit 1671d61

Please sign in to comment.