Skip to content

Commit

Permalink
add pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
karissawhiting committed Apr 25, 2024
1 parent 11d7d5c commit 7d4914f
Show file tree
Hide file tree
Showing 6 changed files with 73 additions and 4 deletions.
5 changes: 5 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
^genomeverse\.Rproj$
^\.Rproj\.user$
^README\.Rmd$
^_pkgdown\.yml$
^docs$
^pkgdown$
^\.github$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
48 changes: 48 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -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/[email protected]
with:
clean: false
branch: gh-pages
folder: docs
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
.Rproj.user
.Rhistory
.RData
.Ruserdata
.DS_Store
inst/doc
docs/
benchmark/lib
docs
/doc/
/Meta/
9 changes: 5 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ Package: genomeverse
Title: What the Package Does (One Line, Title Case)
Version: 0.0.0.9000
Authors@R:
person("First", "Last", , "first.last@example.com", role = c("aut", "cre"),
comment = c(ORCID = "YOUR-ORCID-ID"))
Description: What the package does (one paragraph).
person("Karissa", "Whiting", , "karissa.whiting@gmail.com", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-4683-1868"))
Description: genomeverse is a collection of R packages that are designed to work together seamlessly to create reproducible clinico-genomic analysis pipelines.
License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a
license
Encoding: UTF-8
Expand All @@ -18,6 +18,7 @@ Imports:
oncokbR (>= 0.0.0.9001),
rstudioapi,
utils
Remotes:
Remotes:
MSKCC-Epi-Bio/gnomeR,
karissawhiting/oncokbR
URL: https://mskcc-epi-bio.github.io/genomeverse/
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://mskcc-epi-bio.github.io/genomeverse/
template:
bootstrap: 5

0 comments on commit 7d4914f

Please sign in to comment.