Skip to content

Commit

Permalink
Update pkgdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
stefpeschel committed Oct 31, 2024
1 parent 5de462f commit 0ad34d5
Show file tree
Hide file tree
Showing 8 changed files with 79 additions and 7 deletions.
4 changes: 4 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
^renv\.lock$
^.*\.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.yaml

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 @@ -5,3 +5,4 @@
NetCoMi.Rproj
.Renviron
.Rprofile
docs
13 changes: 10 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@ Package: NetCoMi
Type: Package
Title: Network Construction and Comparison for Microbiome Data
Version: 1.1.0
Author: Stefanie Peschel [aut, cre]
Maintainer: Stefanie Peschel <[email protected]>
Authors@R: c(
person("Stefanie", "Peschel", email = "[email protected]",
role = c("aut", "cre"), comment = c(ORCID = "0000-0002-7936-7627")),
person("Christian", "Müller", "L.", role = "ctb", comment = c(ORCID = "0000-0002-3821-7083")),
person("Anne-Laure", "Boulesteix", role = "ctb", comment = c(ORCID = "0000-0002-2729-0947")),
person("Erika", "von Mutius", role = "ctb", comment = c(ORCID = "0000-0002-8893-4515")),
person("Martin", "Depner", role = "ctb")
)
Description: NetCoMi offers functions for constructing, analyzing, and comparing
microbial association networks as well as dissimilarity-based networks for
microbial compositional data. It also includes functionality for
Expand Down Expand Up @@ -57,4 +63,5 @@ Suggests:
zCompositions
RdMacros: Rdpack
Encoding: UTF-8
RoxygenNote: 7.2.2
RoxygenNote: 7.3.2
URL: https://stefpeschel.github.io/NetCoMi/
5 changes: 1 addition & 4 deletions R/NetCoMi-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,4 @@
#' (inspiration and theoretical background)
#' \item Anastasiia Holovchak (package testing and editing)
#' }
#'
#' @name NetCoMi-package
#' @docType package
NULL
"_PACKAGE"
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://stefpeschel.github.io/NetCoMi/
template:
bootstrap: 5

8 changes: 8 additions & 0 deletions man/NetCoMi-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0ad34d5

Please sign in to comment.