Add branch install notes to readme (plus clean up) (#41)

* Bump roxygen2 version to latest

* Add branch note to readme and copy text from dfeR, add contributing file

* add lintr config with limit matching CRAN and style_dir() to tidy code

* add PR template

* fix contributing headers

* tidy up after conflict resolution

* attempt a github action for the test dashboard

* try to stop false positives coming from global variable binding by pre-loading the packages

* remove renv from test dashboard yaml

* fix typo in test_dashboard gha

* try adding devtools to description (test_dashboard gha)

* make sure that GHA will fail if the test dashboard tests fail

* Revert "make sure that GHA will fail if the test dashboard tests fail"

This reverts commit 1503c49.

* put the local package into the setup r dependencies step, update CodeQL version

* add a code of conduct (same as dfeR)

* copy dfeR issue templates

* update test_dashboard tests (did some tidy up while looking at adding something for the support panel)

* rebuild favicons to make them appear on pkgdown site

* linting and responding to test notes

* fix brackets in code of conduct

* add missing families and update ids in test dashboard

* Increment version number to 0.3.0

* PR response and standardise examples / vignette for cookies

* Add init_analytics() into news!

* remove duplicate branch install instructions (turns out we had added it on another branch!)

* run r cmd check on all pull requests

* Part 1 - update cookie to cookies (#42)

* update cookie to cookies

* run r cmd check on all pull requests

* Part 2 - Make init code inline (#44)

* Update init_analytics to have a create_file option and add more unit tests around the content

* Move the init_analytics HTML / JS to be written inline

* Prevent init_analytics from running in examples and creating scripts in the check directory

* update init_cookies to have the JS code inline and add some tests

* Part 3 - remove tab dependencies (#43)

* update cookie to cookies

* remove tabPanel from within our functions

* remove images from snapshots as not needed

* Switch support panel tests to unit tests (as the UI ones didn't track anything beyond if the tab was selected)

* Add tests for cookies_panel_ui

* Add note to contributing guidelines about lintr and loading package first

* run r cmd check on all PRs

* force some extra waits

* Clarified usethis makes blank scripts and have updated readme so users will install the correct package

* update news.md with changes on this branch

* update news.md

.Rbuildignore

@@ -6,3 +6,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^.lintr$

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,126 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [email protected]. 
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion).
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
+
+[homepage]: https://www.contributor-covenant.org

.github/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to dfeshiny
+
+Try and make use of the [usethis](https://usethis.r-lib.org/) package wherever possible.
+
+When you initially clone the package, the first thing you'll need to do is install [devtools](https://devtools.r-lib.org/):
+
+```
+install.packages("devtools")
+```
+
+Then to load in the package in its current form:
+
+```
+devtools::load_all()
+```
+
+## Adding a package/dependency
+
+`usethis::use_package(<package_name>)`
+
+Note that when adding a function from another package into one of the dfeshiny functions you will need to explicitly state the package in the function call, e.g.:
+
+```package::function()```
+
+Alternatively, if there's a lot of uses of a single function within one of our R scripts, you can call that function once at the top of the R script, e.g:
+
+```
+@' importFrom package function
+```
+
+For more information see the [roxygen2 documentation on declaring dependencies](https://roxygen2.r-lib.org/articles/namespace.html).
+
+## Creating a new function script
+
+`usethis::use_r(name = <script_name>)`
+
+This will create a new blank script within the package R/ folder.
+
+## Creating a new function test script
+
+`usethis::use_test(name = <script_name>)`
+
+This will create a new blank test script within the package testthat/ folder.
+
+## Updating the package version
+
+Once changes have been completed, reviewed and are ready for use in the wild, you
+can increment the package version using:
+
+`usethis::use_version()`
+
+Once you've incremented the version number, it'll add a new heading to news.md.
+
+Add a summary under news.md and then accept it's offer to commit on your behalf.
+
+Once pushed and on the main branch, create a new release in GitHub itself.
+
+## Running tests
+
+You should run the following lines to test the package locally:
+``` 
+# To check functionality
+devtools::check() # Ctrl-Shft-E
+shinytest2::test_app("tests/test_dashboard") # important as not currently ran in CI checks
+
+# For code styling
+styler::style_pkg()
+lintr::lint_package()
+```
+
+If you get a lot of lintr errors, particularly around things not being defined, make sure to load the package first using Ctrl-Shft-L or `devtools::load_all(".")`, then run again. There's a known issue with lintr not picking up on bindings until packages are loaded

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+## How to reproduce
+Steps to reproduce the behaviour:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected behaviour
+A clear and concise description of what you expected to happen.
+
+## Screenshots
+If applicable, add screenshots to help explain your problem.
+
+## Additional context
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...], or wouldn't it be nice if [...].
+
+## Describe the solution you'd like
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+<!-- 
+Hey, thanks for raising a PR! We're excited to see what you've done!
+To help us review the changes, please complete each section in this template by replacing '...' with details to help the reviewers of this pull request. 
+-->
+
+# Brief overview of changes
+
+...
+
+## Why are these changes being made?
+
+...
+
+## Detailed description of changes
+
+...
+
+## Additional information for reviewers
+
+...
+
+## Issue ticket number/s and link
+
+...

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

@@ -4,7 +4,6 @@ on:
   push:
     branches: [main, master]
   pull_request:
-    branches: [main, master]
 
 name: R-CMD-check
 

.github/workflows/lintr.yml

@@ -33,23 +33,24 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Setup R
-        uses: r-lib/actions/setup-r@4e1feaf90520ec1215d1882fdddfe3411c08e492
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
 
-      - name: Setup lintr
-        uses: r-lib/actions/setup-r-dependencies@4e1feaf90520ec1215d1882fdddfe3411c08e492
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: lintr
+          extra-packages: any::lintr, local::.
+          needs: lint
 
       - name: Run lintr
         run: lintr::sarif_output(lintr::lint_dir("."), "lintr-results.sarif")
         shell: Rscript {0}
         continue-on-error: true
 
       - name: Upload analysis results to GitHub
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: lintr-results.sarif
           wait-for-processing: true

.github/workflows/test_dashboard.yaml

@@ -0,0 +1,46 @@
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+name: Test dashboard
+
+jobs:
+  automatedTests:
+    runs-on: ${{ matrix.config.os }}
+
+    name: shiny-tests
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: ubuntu-latest, r: 'release'}
+
+    env:
+      R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
+      RSPM: ${{ matrix.config.rspm }}
+      RENV_PATHS_ROOT: ~/.local/share/renv
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - name: Install dependencies
+        uses: r-lib/actions/setup-r-dependencies@v2
+
+      - name: Run tests
+        shell: Rscript {0}
+        run: |
+          shiny::runTests("tests/test_dashboard", assert = TRUE)
+
+      - name: Upload test results
+        if: failure()
+        uses: actions/upload-artifact@master
+        with:
+          name: ${{ runner.os }}-r${{ matrix.config.r }}-tests
+          path: tests

.lintr

@@ -0,0 +1,3 @@
+linters:  linters_with_defaults(
+    line_length_linter = line_length_linter(100L) # limit CRAN sets for lines in PDF documentation
+  )

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: dfeshiny
 Title: DfE R-Shiny Standards
-Version: 0.2.0
+Version: 0.3.0
 Authors@R: c(
     person("Rich", "Bielby", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-9070-9969")),
@@ -26,6 +26,7 @@ Suggests:
     knitr,
     rmarkdown,
     shinytest2,
+    devtools,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 Encoding: UTF-8

NAMESPACE

@@ -1,11 +1,11 @@
 # Generated by roxygen2: do not edit by hand
 
-export(cookie_banner_server)
-export(cookie_banner_ui)
+export(cookies_banner_server)
+export(cookies_banner_ui)
 export(cookies_panel_server)
 export(cookies_panel_ui)
 export(custom_disconnect_message)
-export(dfe_cookie_script)
+export(dfe_cookies_script)
 export(init_analytics)
 export(init_cookies)
 export(support_panel)