Skip to content

Commit

Permalink
Added package URL using pkgdown.
Browse files Browse the repository at this point in the history
  • Loading branch information
PratibhaPanwar committed Jul 25, 2024
1 parent 8314085 commit bad14a4
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
^.*\.Rproj$
^\.Rproj\.user$
^_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
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/[email protected]
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
Expand Up @@ -2,3 +2,4 @@
.Rhistory
.RData
.Ruserdata
docs
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Package: clustSIGNAL
Type: Package
Title: clustSIGNAL: a spatial clustering method
Version: 0.1.0
Author:c(
Author: c(
person(given = "Pratibha", family = "Panwar", email = "[email protected]", role = c("cre", "aut")),
person(given = "Boyi", family = "Guo", email = "", role = "aut")),
person(given = "Haowen", family = "Zhao", email = "", role = "aut")),
Expand All @@ -23,3 +23,4 @@ Depends: R (>= 4.0.0), SpatialExperiment, doParallel
Imports: BiocNeighbors, bluster, scater
Suugests: knitr, rmarkdown
VignetteBuilder: knitr
URL: https://sydneybiox.github.io/clustSIGNAL/
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://sydneybiox.github.io/clustSIGNAL/
template:
bootstrap: 5

0 comments on commit bad14a4

Please sign in to comment.