diff --git a/.Rbuildignore b/.Rbuildignore index 38500c6..c97d6d7 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -42,3 +42,6 @@ ^rawdata/ ^CRAN-SUBMISSION$ ^\.editorconfig$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..85315dd --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,51 @@ +# 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: + - v* + pull_request: + branches: + - v* + 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@v3 + + - 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.4.1 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index eef8e90..8150162 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ doc Meta ^cran-comments\.md$ +docs diff --git a/DESCRIPTION b/DESCRIPTION index bf739d1..f5982fa 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,11 +2,12 @@ Package: oolong Title: Create Validation Tests for Automated Content Analysis Version: 0.5.1 Authors@R: - c(person(given = "Chung-hong", family = "Chan", role = c("aut", "cre"), email = "chainsawtiney@gmail.com", comment = c(ORCID = "0000-0002-6232-7530")), person(given = "Marius", family = "Sältzer", role = c("aut"), email = "msaeltze@mail.uni-mannheim.de", comment = c(ORCID = "0000-0002-8604-4666"))) + c(person(given = "Chung-hong", family = "Chan", role = c("aut", "cre"), email = "chainsawtiney@gmail.com", comment = c(ORCID = "0000-0002-6232-7530")), + person(given = "Marius", family = "Sältzer", role = c("aut"), email = "msaeltze@mail.uni-mannheim.de", comment = c(ORCID = "0000-0002-8604-4666"))) Description: Intended to create standard human-in-the-loop validity tests for typical automated content analysis such as topic modeling and dictionary-based methods. This package offers a standard workflow with functions to prepare, administer and evaluate a human-in-the-loop validity test. This package provides functions for validating topic models using word intrusion, topic intrusion (Chang et al. 2009, ) and word set intrusion (Ying et al. 2021) tests. This package also provides functions for generating gold-standard data which are useful for validating dictionary-based methods. The default settings of all generated tests match those suggested in Chang et al. (2009) and Song et al. (2020) . License: LGPL (>= 2.1) Encoding: UTF-8 -URL: https://github.com/gesistsa/oolong +URL: https://gesistsa.github.io/oolong, https://github.com/gesistsa/oolong LazyData: true Depends: R (>= 4.0) @@ -43,3 +44,4 @@ Suggests: BugReports: https://github.com/gesistsa/oolong/issues VignetteBuilder: knitr Config/testthat/edition: 3 +Config/Needs/website: gesistsa/tsatemplate diff --git a/README.Rmd b/README.Rmd index 37dfa73..0f8bc05 100644 --- a/README.Rmd +++ b/README.Rmd @@ -14,7 +14,7 @@ knitr::opts_chunk$set( set.seed(42) ``` -# oolong +# oolong [![Codecov test coverage](https://codecov.io/gh/gesistsa/oolong/branch/v0.5/graph/badge.svg)](https://codecov.io/gh/gesistsa/oolong?branch=v0.5) diff --git a/README.md b/README.md index 9dd23cf..8488f84 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# oolong +# oolong diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..da1fee5 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,3 @@ +url: https://gesistsa.github.io/oolong/ +template: + package: tsatemplate diff --git a/man/figures/oolong_logo.png b/man/figures/oolong_logo.png new file mode 100644 index 0000000..9579a22 Binary files /dev/null and b/man/figures/oolong_logo.png differ