diff --git a/.Rbuildignore b/.Rbuildignore index 0f304d3..b7f4539 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -6,3 +6,6 @@ SECURITY.md .bat .pdf ^\.github$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index 0f2fe08..562fe0f 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -4,9 +4,8 @@ on: push: branches: [main, master] pull_request: - branches: [main, master] -name: R-CMD-check +name: R-CMD-check.yaml permissions: read-all 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/DESCRIPTION b/DESCRIPTION index 3bc5fdc..2d0581c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -19,7 +19,7 @@ Suggests: data.table Description: A statistical disclosure control tool to protect frequency tables in cases where small values are sensitive. The function PLSrounding() performs small count rounding of necessary inner cells so that all small frequencies of cross-classifications to be published (publishable cells) are rounded. This is equivalent to changing micro data since frequencies of unique combinations are changed. Thus, additivity and consistency are guaranteed. The methodology is described in Langsrud and Heldal (2018) . License: MIT + file LICENSE -URL: https://github.com/statisticsnorway/ssb-smallcountrounding +URL: https://github.com/statisticsnorway/ssb-smallcountrounding, https://statisticsnorway.github.io/ssb-smallcountrounding/ BugReports: https://github.com/statisticsnorway/ssb-smallcountrounding/issues Roxygen: list(markdown = TRUE) RoxygenNote: 7.3.1 diff --git a/README.md b/README.md index a4a94a6..d5a77ed 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ # R package SmallCountRounding + + +| [SmallCountRounding on CRAN](https://cran.r-project.org/package=SmallCountRounding) | | [pkgdown website](https://statisticsnorway.github.io/ssb-smallcountrounding/) | | [GitHub Repository](https://github.com/statisticsnorway/ssb-smallcountrounding) | +|----------------------|---|----------------------|---|----------------------| + + +*** + + [![Mentioned in Awesome Official Statistics ](https://awesome.re/mentioned-badge.svg)](http://www.awesomeofficialstatistics.org) diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..8f7ac14 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://statisticsnorway.github.io/ssb-smallcountrounding/ +template: + bootstrap: 5 +