Switch to rmarkdown documentation and added github pages with pkgdown

.Rbuildignore

@@ -1,2 +1,8 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^LICENSE\.md$
+^README\.Rmd$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/pkgdown.yaml

@@ -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

.gitignore

@@ -2,3 +2,4 @@
 .Rhistory
 .RData
 .Ruserdata
+docs

DESCRIPTION

@@ -1,11 +1,13 @@
 Package: ProTrackR
 Type: Package
 Title: Manipulate and Play 'ProTracker' Modules
-Version: 0.3.8
-Date: 2023-08-22
-Authors@R: c(person("Pepijn", "de Vries", role =c("aut", "cre", "dtc"),
-    email = "[email protected]"))
-Author: Pepijn de Vries [aut, cre, dtc]
+Version: 0.3.9
+Date: 2024-02-14
+Authors@R: c(person("Pepijn", "de Vries", role = c("aut", "cre", "dtc"),
+    email = "[email protected]",
+    comment = c(ORCID = "0000-0002-7961-6646")))
+Author:
+    Pepijn de Vries [aut, cre, dtc] (0000-0002-7961-6646)
 Maintainer: Pepijn de Vries <[email protected]>
 Description: 'ProTracker' is a popular music tracker to sequence
     music on a Commodore Amiga machine. This package offers the
@@ -15,11 +17,14 @@ Description: 'ProTracker' is a popular music tracker to sequence
     intends to contribute to this popularity and therewith
     keeping the legacy of 'ProTracker' and the Commodore Amiga
     alive.
-License: GPL-3
+License: GPL (>= 3)
 LazyData: True
 Depends: audio, lattice, signal, tuneR (>= 1.0)
 Imports: graphics, methods, stats, utils, XML
 Suggests: AmigaFFH (>= 0.2.0)
 Encoding: UTF-8
 RoxygenNote: 7.2.3
+Roxygen: list(markdown = TRUE)
 NeedsCompilation: no
+URL: https://pepijn-devries.github.io/ProTrackR/, https:://www.github.com/pepijn-devries/ProTrackR/
+BugReports: https://github.com/pepijn-devries/ProTrackR/issues

NEWS → NEWS.md

@@ -1,3 +1,9 @@
+ProTrackR v0.3.9 (Release date: 2023-02-14)
+=============
+
+ * Added `pkgdown` website and README
+ * switched to RMarkdown mode for roxygen2 documentation
+
 ProTrackR v0.3.8 (Release date: 2023-08-22)
 =============
 

ProTrackR.Rproj

@@ -15,4 +15,4 @@ LaTeX: pdfLaTeX
 BuildType: Package
 PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
-PackageRoxygenize: rd,collate,namespace
+PackageRoxygenize: rd,collate,namespace,vignette