diff --git a/.Rbuildignore b/.Rbuildignore index 0f4ea00..ff03e00 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -4,3 +4,6 @@ ^LICENSE\.md$ _pkgdown.yml ^docs$ +^_pkgdown\.yml$ +^pkgdown$ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..bfc9f4d --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,49 @@ +# 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: + 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/github-pages-deploy-action@v4.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index 482426e..497e825 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ ramptools.Rproj *.html *.Rd +docs diff --git a/DESCRIPTION b/DESCRIPTION index 5252f1a..2439fbd 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -29,3 +29,4 @@ Suggests: Config/testthat/edition: 3 BuildManual: TRUE VignetteBuilder: knitr +URL: https://dd-harp.github.io/ramptools/ diff --git a/_pkgdown.yml b/_pkgdown.yml index a2ac143..616427e 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -61,18 +61,19 @@ reference: - title: Cloud Utilities desc: Utilities to Access the Data Warehouse contents: - - bq_connect - - bq_get_latest_version - - bq_get_version_metadata - - bq_get_data - - bq_get_db_diff - - bq_get_clean_data - - bq_get_imputed_sample - - bq_append_raw_data - - bq_append_version_metadata - - bq_write_clean_data - - bq_write_imputed_data - - bq_init_tables - - bq_write_outbreak_data - - bq_get_outbreak_data - - ramptools-package + - bq_connect + - bq_get_latest_version + - bq_get_version_metadata + - bq_get_data + - bq_get_db_diff + - bq_get_clean_data + - bq_get_imputed_sample + - bq_append_raw_data + - bq_append_version_metadata + - bq_write_clean_data + - bq_write_imputed_data + - bq_init_tables + - bq_write_outbreak_data + - bq_get_outbreak_data + - ramptools-package + diff --git a/man/ramptools-package.Rd b/man/ramptools-package.Rd index 6cd1810..1abe6d2 100644 --- a/man/ramptools-package.Rd +++ b/man/ramptools-package.Rd @@ -7,6 +7,13 @@ \title{ramptools: RAMP Uganda Malaria Data Tools} \description{ Shared metadata tables and utility functions for the Uganda RAMP (Routine Assessment of Malaria Programs) project. Provides location hierarchies, indicator mappings, shapefiles, and database read/write utilities for both local SQLite and Google BigQuery backends. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://dd-harp.github.io/ramptools/} +} + } \author{ \strong{Maintainer}: Austin Carter \email{aucarter@uw.edu} (\href{https://orcid.org/0000-0002-3588-6142}{ORCID})