From 6d530e6313549dfb3514bc357c10273fa3d3f153 Mon Sep 17 00:00:00 2001 From: cjrace <52536248+cjrace@users.noreply.github.com> Date: Wed, 4 Sep 2024 10:02:27 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20dfe-anal?= =?UTF-8?q?ytical-services/dfeshiny@48f848d7c32af0899d4c4ecb3cab2bf4633327?= =?UTF-8?q?ff=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 8 +- CODE_OF_CONDUCT.html | 124 ++++++++++++++++ CONTRIBUTING.html | 104 +++++++++++++ LICENSE.html | 9 +- PULL_REQUEST_TEMPLATE.html | 77 ++++++++++ apple-touch-icon-120x120.png | Bin 0 -> 28604 bytes apple-touch-icon-152x152.png | Bin 0 -> 41341 bytes apple-touch-icon-180x180.png | Bin 0 -> 54120 bytes apple-touch-icon-60x60.png | Bin 0 -> 10823 bytes apple-touch-icon-76x76.png | Bin 0 -> 14657 bytes apple-touch-icon.png | Bin 0 -> 54120 bytes articles/implementing-cookies.html | 53 ++++--- articles/index.html | 11 +- authors.html | 13 +- favicon-16x16.png | Bin 0 -> 3811 bytes favicon-32x32.png | Bin 0 -> 5586 bytes favicon.ico | Bin 223430 -> 15086 bytes index.html | 93 ++++-------- logo.png | Bin 0 -> 99134 bytes news/index.html | 44 +++++- pkgdown.yml | 2 +- reference/cookies.html | 62 +++++--- reference/cookies_banner_server.html | 179 +++++++++++++++++++++++ reference/cookies_banner_ui.html | 162 ++++++++++++++++++++ reference/cookies_panel_server.html | 64 +++++--- reference/cookies_panel_ui.html | 63 +++++--- reference/custom_disconnect_message.html | 15 +- reference/dfe_cookies_script.html | 8 + reference/figures/logo.png | Bin 0 -> 99134 bytes reference/index.html | 21 ++- reference/init_analytics.html | 36 ++--- reference/init_cookies.html | 67 +++++---- reference/support_panel.html | 97 +++++++++--- reference/tidy_code.html | 9 +- search.json | 2 +- sitemap.xml | 8 +- 36 files changed, 1047 insertions(+), 284 deletions(-) create mode 100644 CODE_OF_CONDUCT.html create mode 100644 CONTRIBUTING.html create mode 100644 PULL_REQUEST_TEMPLATE.html create mode 100644 apple-touch-icon-120x120.png create mode 100644 apple-touch-icon-152x152.png create mode 100644 apple-touch-icon-180x180.png create mode 100644 apple-touch-icon-60x60.png create mode 100644 apple-touch-icon-76x76.png create mode 100644 apple-touch-icon.png create mode 100644 favicon-16x16.png create mode 100644 favicon-32x32.png create mode 100644 logo.png create mode 100644 reference/cookies_banner_server.html create mode 100644 reference/cookies_banner_ui.html create mode 100644 reference/dfe_cookies_script.html create mode 100644 reference/figures/logo.png diff --git a/404.html b/404.html index 36615ed..73c1dc5 100644 --- a/404.html +++ b/404.html @@ -18,6 +18,7 @@ + Skip to contents @@ -27,7 +28,7 @@ dfeshiny - 0.2.0 + 0.3.0 @@ -57,8 +58,7 @@
diff --git a/CODE_OF_CONDUCT.html b/CODE_OF_CONDUCT.html new file mode 100644 index 0000000..fd0bca3 --- /dev/null +++ b/CODE_OF_CONDUCT.html @@ -0,0 +1,124 @@ + +Contributor Covenant Code of Conduct • dfeshiny + Skip to contents + + +
+
+
+ +
+ +
+

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 . 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, 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.

+

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.

+
+
+ +
+ + +
+ + + +
+ + + + + + + diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html new file mode 100644 index 0000000..14cae20 --- /dev/null +++ b/CONTRIBUTING.html @@ -0,0 +1,104 @@ + +Contributing to dfeshiny • dfeshiny + Skip to contents + + +
+
+
+ +
+ +

Try and make use of the usethis package wherever possible.

+

When you initially clone the package, the first thing you’ll need to do is install devtools:

+
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.

+
+
+

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

+
+
+ +
+ + +
+ + + +
+ + + + + + + diff --git a/LICENSE.html b/LICENSE.html index 18be6f4..f6c68b5 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -1,5 +1,5 @@ -GNU General Public License • dfeshiny +GNU General Public License • dfeshiny Skip to contents @@ -7,7 +7,7 @@ dfeshiny - 0.2.0 + 0.3.0 -