Update documentation

.Rbuildignore

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

.github/.gitignore

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

.github/workflows/R-CMD-check.yaml

@@ -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]
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macos-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          - {os: ubuntu-latest,   r: 'oldrel-1'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

.github/workflows/pkgdown.yaml

@@ -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
+
+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 Nenuial 🚀
+        if: github.event_name != 'pull_request'
+        uses: burnett01/[email protected]
+        with:
+          switches: -avz
+          path: docs/
+          remote_path: ${{ secrets.DEPLOY_PATH }}
+          remote_host: ${{ secrets.DEPLOY_HOST }}
+          remote_port: ${{ secrets.DEPLOY_PORT }}
+          remote_user: ${{ secrets.DEPLOY_USER }}
+          remote_key: ${{ secrets.DEPLOY_KEY }}

DESCRIPTION

@@ -1,42 +1,54 @@
 Package: geovizr
 Type: Package
-Title: Provide Support For RMarkdown
+Title: Provide Support for Knitr (Quarto/Rmd)
 Version: 0.2.0
-Author: Pascal Burkhard
-Maintainer: Pascal Burkhard <[email protected]>
-Description: Provide support function for the RMarkdown files-
-License: CC0
+Authors@R: 
+    person("Pascal", "Burkhard", , "[email protected]", role = c("aut", "cre"),
+           comment = c(ORCID = "0009-0001-5504-5084"))
+Description: Provide support functions for the Quarto and Rmd documents.
+License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.3.1
 Imports: 
+    bookdown,
+    chunkhooks,
+    dplyr,
     fs,
+    geodata,
+    geotools,
+    ggeo,
+    ggplot2,
+    glue,
     here,
+    janitor,
+    knitr,
+    pdftools,
+    purrr,
+    quarto,
+    lifecycle,
+    magrittr,
+    tibble,
+    tidyr,
     readr,
     rlang,
     rmarkdown,
+    rnotion,
     stringr,
-    yaml,
-    tibble,
-    tidyr,
-    dplyr,
-    janitor,
-    purrr,
-    tinytex,
     xfun,
+    yaml
+Suggests:
     downlit,
-    tufte,
-    magick,
-    pdftools,
-    kableExtra,
     gt,
+    kableExtra,
+    magick,
     ragg,
-    chunkhooks,
-    lifecycle,
-    tweetrmd,
-    ggeo,
-    magrittr
+    tinytex,
+    tufte
 Remotes:
-    gadenbuie/tweetrmd,
-    Nenuial/ggeo
+    Nenuial/ggeo,
+    Nenuial/geodata,
+    Nenuial/geotools,
+    Nenuial/rnotion
 Roxygen: list(markdown = TRUE)
+Config/Needs/website: nenuial/geopkg

LICENSE

@@ -0,0 +1,2 @@
+YEAR: 2024
+COPYRIGHT HOLDER: geovizr authors

LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 geovizr authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

R/df_cosmology.R

@@ -1,6 +1,14 @@
 #' Format cosmology object box
 #'
+#' @param name Name of the cosmology object
+#'
+#'   This can be one of *Sun, Mercury, Venus, Earth, Mars,
+#'   Jupiter, Saturn, Uranus, Neptune* or *Pluto*.
+#'
 #' @export
+#' @examplesIf interactive()
+#' # Not run: should be used in Rmd/Quarto documents
+#'
 gvz_cosmo_solar_system_object <- function(name) {
   geodata::df_cosmology_solar_system_objects |>
     dplyr::filter(english == name) -> object_data

R/geovizr-package.R

@@ -0,0 +1,14 @@
+#' @keywords internal
+"_PACKAGE"
+
+## usethis namespace: start
+## usethis namespace: end
+NULL
+
+# Globals
+utils::globalVariables(c("lines", "code", "arg", "content", "english",
+                         "text", ".x"))
+
+#' @importFrom magrittr %>%
+#' @export
+magrittr::`%>%`

R/knit_children.R

@@ -1,6 +1,7 @@
 #' Knit child for MF oral exams
 #'
-#' @param ...
+#' @param ... Data that is passed to the fragment
+#'   Must have *ID*, *Name*, *Subject* and *Question*
 #'
 #' @return Knitted document
 #' @export