diff --git a/.Rbuildignore b/.Rbuildignore index b6dde63..6022675 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -4,3 +4,6 @@ ^\.github$ ^LICENSE\.md$ ^data-raw$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ 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 accfb7b..667204b 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ .httr-oauth .DS_Store .quarto +docs diff --git a/DESCRIPTION b/DESCRIPTION index 6e37a1b..0f52a51 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -22,7 +22,7 @@ Imports: rlang, tidytable LazyData: true -URL: https://github.com/RTIInternational/SampleSelectR +URL: https://github.com/RTIInternational/SampleSelectR, https://rtiinternational.github.io/SampleSelectR/ BugReports: https://github.com/RTIInternational/SampleSelectR/issues Suggests: testthat (>= 3.0.0) diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..76da62b --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,29 @@ +url: https://rtiinternational.github.io/SampleSelectR/ +template: + bootstrap: 5 + bootswatch: flatly + light-switch: true + +reference: + - title: Main functions + desc: Primary functions + contents: + - allocate + - select_sample + + + - title: Utility functions + desc: These functions are called in the main functions but we chose not to make them hidden + contents: + - chromy_pps + - srs + - sys + - sys_pps + - serp_sort + + - title: Data + desc: Example sampling frames from public data + contents: + - ipeds + - county_2023 + - puma_2023