diff --git a/.Rbuildignore b/.Rbuildignore index 32b1276..1ae6f7c 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,2 +1,5 @@ ^dfeshiny\.Rproj$ ^\.Rproj\.user$ +^LICENSE\.md$ +^\.github$ +^codecov\.yml$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml new file mode 100644 index 0000000..74d8c97 --- /dev/null +++ b/.github/workflows/R-CMD-check.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: + branches: [main, master] + +name: R-CMD-check + +jobs: + R-CMD-check: + runs-on: ${{ matrix.config.os }} + + name: ${{ matrix.config.os }} (${{ matrix.config.r }}) + + strategy: + fail-fast: false + matrix: + config: + - {os: macos-latest, r: 'release'} + - {os: windows-latest, r: 'release'} + - {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'} + - {os: ubuntu-latest, r: 'release'} + - {os: ubuntu-latest, r: 'oldrel-1'} + + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + R_KEEP_PKG_SOURCE: yes + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + r-version: ${{ matrix.config.r }} + http-user-agent: ${{ matrix.config.http-user-agent }} + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::rcmdcheck + needs: check + + - uses: r-lib/actions/check-r-package@v2 + with: + upload-snapshots: true diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml new file mode 100644 index 0000000..960234c --- /dev/null +++ b/.github/workflows/test-coverage.yaml @@ -0,0 +1,50 @@ +# 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: + branches: [main, master] + +name: test-coverage + +jobs: + test-coverage: + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::covr + needs: coverage + + - name: Test coverage + run: | + covr::codecov( + quiet = FALSE, + clean = FALSE, + install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package") + ) + shell: Rscript {0} + + - name: Show testthat output + if: always() + run: | + ## -------------------------------------------------------------------- + find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true + shell: bash + + - name: Upload test results + if: failure() + uses: actions/upload-artifact@v4 + with: + name: coverage-test-failures + path: ${{ runner.temp }}/package diff --git a/DESCRIPTION b/DESCRIPTION index 8dddff2..c398514 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,20 +1,24 @@ Package: dfeshiny Title: DfE R-Shiny Standards Version: 0.1.1 -Authors@R: +Authors@R: c( person("Rich", "Bielby", , "richard.bielby@education.gov.uk", role = c("aut", "cre"), - comment = c(ORCID = "0000-0001-9070-9969")) -Description: R package containing preferred methods for creating official DfE R-Shiny dashboards. -License: `use_gpl3_license()` -Encoding: UTF-8 + comment = c(ORCID = "0000-0001-9070-9969")), + person("Cam", "Race", , "cameron.race@education.gov.uk", role = "aut") + ) +Description: R package containing preferred methods for creating official + DfE R-Shiny dashboards. +License: GPL (>= 3) Imports: - shinyGovstyle, shiny, + shinyGovstyle, + shinyjs, styler -Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 Suggests: - testthat (>= 3.0.0), + diffviewer, shinytest2, - diffviewer + testthat (>= 3.0.0) Config/testthat/edition: 3 +Encoding: UTF-8 +Roxygen: list(markdown = TRUE) +RoxygenNote: 7.3.1 diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..175443c --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,595 @@ +GNU General Public License +========================== + +_Version 3, 29 June 2007_ +_Copyright © 2007 Free Software Foundation, Inc. <>_ + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for software and other +kinds of works. + +The licenses for most software and other practical works are designed to take away +your freedom to share and change the works. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change all versions of a +program--to make sure it remains free software for all its users. We, the Free +Software Foundation, use the GNU General Public License for most of our software; it +applies also to any other work released this way by its authors. You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General +Public Licenses are designed to make sure that you have the freedom to distribute +copies of free software (and charge for them if you wish), that you receive source +code or can get it if you want it, that you can change the software or use pieces of +it in new free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you these rights or +asking you to surrender the rights. Therefore, you have certain responsibilities if +you distribute copies of the software, or if you modify it: responsibilities to +respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for a fee, +you must pass on to the recipients the same freedoms that you received. You must make +sure that they, too, receive or can get the source code. And you must show them these +terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: **(1)** assert +copyright on the software, and **(2)** offer you this License giving you legal permission +to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that there is +no warranty for this free software. For both users' and authors' sake, the GPL +requires that modified versions be marked as changed, so that their problems will not +be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified versions of +the software inside them, although the manufacturer can do so. This is fundamentally +incompatible with the aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we have designed +this version of the GPL to prohibit the practice for those products. If such problems +arise substantially in other domains, we stand ready to extend this provision to +those domains in future versions of the GPL, as needed to protect the freedom of +users. + +Finally, every program is threatened constantly by software patents. States should +not allow patents to restrict development and use of software on general-purpose +computers, but in those that do, we wish to avoid the special danger that patents +applied to a free program could make it effectively proprietary. To prevent this, the +GPL assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions + +“This License” refers to version 3 of the GNU General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work in +a fashion requiring copyright permission, other than the making of an exact copy. The +resulting work is called a “modified version” of the earlier work or a +work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based on +the Program. + +To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for infringement under +applicable copyright law, except executing it on a computer or modifying a private +copy. Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through a computer +network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” to the +extent that it includes a convenient and prominently visible feature that **(1)** +displays an appropriate copyright notice, and **(2)** tells the user that there is no +warranty for the work (except to the extent that warranties are provided), that +licensees may convey the work under this License, and how to view a copy of this +License. If the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code + +The “source code” for a work means the preferred form of the work for +making modifications to it. “Object code” means any non-source form of a +work. + +A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of interfaces +specified for a particular programming language, one that is widely used among +developers working in that language. + +The “System Libraries” of an executable work include anything, other than +the work as a whole, that **(a)** is included in the normal form of packaging a Major +Component, but which is not part of that Major Component, and **(b)** serves only to +enable use of the work with that Major Component, or to implement a Standard +Interface for which an implementation is available to the public in source code form. +A “Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system (if any) on which +the executable work runs, or a compiler used to produce the work, or an object code +interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all the +source code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. However, +it does not include the work's System Libraries, or general-purpose tools or +generally available free programs which are used unmodified in performing those +activities but which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for the work, and +the source code for shared libraries and dynamically linked subprograms that the work +is specifically designed to require, such as by intimate data communication or +control flow between those subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +### 2. Basic Permissions + +All rights granted under this License are granted for the term of copyright on the +Program, and are irrevocable provided the stated conditions are met. This License +explicitly affirms your unlimited permission to run the unmodified Program. The +output from running a covered work is covered by this License only if the output, +given its content, constitutes a covered work. This License acknowledges your rights +of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey covered +works to others for the sole purpose of having them make modifications exclusively +for you, or provide you with facilities for running those works, provided that you +comply with the terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for you must do so +exclusively on your behalf, under your direction and control, on terms that prohibit +them from making any copies of your copyrighted material outside their relationship +with you. + +Conveying under any other circumstances is permitted solely under the conditions +stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law + +No covered work shall be deemed part of an effective technological measure under any +applicable law fulfilling obligations under article 11 of the WIPO copyright treaty +adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention +of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention of +technological measures to the extent such circumvention is effected by exercising +rights under this License with respect to the covered work, and you disclaim any +intention to limit operation or modification of the work as a means of enforcing, +against the work's users, your or third parties' legal rights to forbid circumvention +of technological measures. + +### 4. Conveying Verbatim Copies + +You may convey verbatim copies of the Program's source code as you receive it, in any +medium, provided that you conspicuously and appropriately publish on each copy an +appropriate copyright notice; keep intact all notices stating that this License and +any non-permissive terms added in accord with section 7 apply to the code; keep +intact all notices of the absence of any warranty; and give all recipients a copy of +this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may offer +support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions + +You may convey a work based on the Program, or the modifications to produce it from +the Program, in the form of source code under the terms of section 4, provided that +you also meet all of these conditions: + +* **a)** The work must carry prominent notices stating that you modified it, and giving a +relevant date. +* **b)** The work must carry prominent notices stating that it is released under this +License and any conditions added under section 7. This requirement modifies the +requirement in section 4 to “keep intact all notices”. +* **c)** You must license the entire work, as a whole, under this License to anyone who +comes into possession of a copy. This License will therefore apply, along with any +applicable section 7 additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no permission to license the +work in any other way, but it does not invalidate such permission if you have +separately received it. +* **d)** If the work has interactive user interfaces, each must display Appropriate Legal +Notices; however, if the Program has interactive interfaces that do not display +Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, which are +not by their nature extensions of the covered work, and which are not combined with +it such as to form a larger program, in or on a volume of a storage or distribution +medium, is called an “aggregate” if the compilation and its resulting +copyright are not used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work in an aggregate +does not cause this License to apply to the other parts of the aggregate. + +### 6. Conveying Non-Source Forms + +You may convey a covered work in object code form under the terms of sections 4 and +5, provided that you also convey the machine-readable Corresponding Source under the +terms of this License, in one of these ways: + +* **a)** Convey the object code in, or embodied in, a physical product (including a +physical distribution medium), accompanied by the Corresponding Source fixed on a +durable physical medium customarily used for software interchange. +* **b)** Convey the object code in, or embodied in, a physical product (including a +physical distribution medium), accompanied by a written offer, valid for at least +three years and valid for as long as you offer spare parts or customer support for +that product model, to give anyone who possesses the object code either **(1)** a copy of +the Corresponding Source for all the software in the product that is covered by this +License, on a durable physical medium customarily used for software interchange, for +a price no more than your reasonable cost of physically performing this conveying of +source, or **(2)** access to copy the Corresponding Source from a network server at no +charge. +* **c)** Convey individual copies of the object code with a copy of the written offer to +provide the Corresponding Source. This alternative is allowed only occasionally and +noncommercially, and only if you received the object code with such an offer, in +accord with subsection 6b. +* **d)** Convey the object code by offering access from a designated place (gratis or for +a charge), and offer equivalent access to the Corresponding Source in the same way +through the same place at no further charge. You need not require recipients to copy +the Corresponding Source along with the object code. If the place to copy the object +code is a network server, the Corresponding Source may be on a different server +(operated by you or a third party) that supports equivalent copying facilities, +provided you maintain clear directions next to the object code saying where to find +the Corresponding Source. Regardless of what server hosts the Corresponding Source, +you remain obligated to ensure that it is available for as long as needed to satisfy +these requirements. +* **e)** Convey the object code using peer-to-peer transmission, provided you inform +other peers where the object code and Corresponding Source of the work are being +offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from the +Corresponding Source as a System Library, need not be included in conveying the +object code work. + +A “User Product” is either **(1)** a “consumer product”, which +means any tangible personal property which is normally used for personal, family, or +household purposes, or **(2)** anything designed or sold for incorporation into a +dwelling. In determining whether a product is a consumer product, doubtful cases +shall be resolved in favor of coverage. For a particular product received by a +particular user, “normally used” refers to a typical or common use of +that class of product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected to use, the +product. A product is a consumer product regardless of whether the product has +substantial commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install and execute +modified versions of a covered work in that User Product from a modified version of +its Corresponding Source. The information must suffice to ensure that the continued +functioning of the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically for +use in, a User Product, and the conveying occurs as part of a transaction in which +the right of possession and use of the User Product is transferred to the recipient +in perpetuity or for a fixed term (regardless of how the transaction is +characterized), the Corresponding Source conveyed under this section must be +accompanied by the Installation Information. But this requirement does not apply if +neither you nor any third party retains the ability to install modified object code +on the User Product (for example, the work has been installed in ROM). + +The requirement to provide Installation Information does not include a requirement to +continue to provide support service, warranty, or updates for a work that has been +modified or installed by the recipient, or for the User Product in which it has been +modified or installed. Access to a network may be denied when the modification itself +materially and adversely affects the operation of the network or violates the rules +and protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord with +this section must be in a format that is publicly documented (and with an +implementation available to the public in source code form), and must require no +special password or key for unpacking, reading or copying. + +### 7. Additional Terms + +“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. Additional +permissions that are applicable to the entire Program shall be treated as though they +were included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part may be +used separately under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when you +modify the work.) You may place additional permissions on material, added by you to a +covered work, for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you add to a +covered work, you may (if authorized by the copyright holders of that material) +supplement the terms of this License with terms: + +* **a)** Disclaiming warranty or limiting liability differently from the terms of +sections 15 and 16 of this License; or +* **b)** Requiring preservation of specified reasonable legal notices or author +attributions in that material or in the Appropriate Legal Notices displayed by works +containing it; or +* **c)** Prohibiting misrepresentation of the origin of that material, or requiring that +modified versions of such material be marked in reasonable ways as different from the +original version; or +* **d)** Limiting the use for publicity purposes of names of licensors or authors of the +material; or +* **e)** Declining to grant rights under trademark law for use of some trade names, +trademarks, or service marks; or +* **f)** Requiring indemnification of licensors and authors of that material by anyone +who conveys the material (or modified versions of it) with contractual assumptions of +liability to the recipient, for any liability that these contractual assumptions +directly impose on those licensors and authors. + +All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you received +it, or any part of it, contains a notice stating that it is governed by this License +along with a term that is a further restriction, you may remove that term. If a +license document contains a further restriction but permits relicensing or conveying +under this License, you may add to a covered work material governed by the terms of +that license document, provided that the further restriction does not survive such +relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, in +the relevant source files, a statement of the additional terms that apply to those +files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a +separately written license, or stated as exceptions; the above requirements apply +either way. + +### 8. Termination + +You may not propagate or modify a covered work except as expressly provided under +this License. Any attempt otherwise to propagate or modify it is void, and will +automatically terminate your rights under this License (including any patent licenses +granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a +particular copyright holder is reinstated **(a)** provisionally, unless and until the +copyright holder explicitly and finally terminates your license, and **(b)** permanently, +if the copyright holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently +if the copyright holder notifies you of the violation by some reasonable means, this +is the first time you have received notice of violation of this License (for any +work) from that copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses of +parties who have received copies or rights from you under this License. If your +rights have been terminated and not permanently reinstated, you do not qualify to +receive new licenses for the same material under section 10. + +### 9. Acceptance Not Required for Having Copies + +You are not required to accept this License in order to receive or run a copy of the +Program. Ancillary propagation of a covered work occurring solely as a consequence of +using peer-to-peer transmission to receive a copy likewise does not require +acceptance. However, nothing other than this License grants you permission to +propagate or modify any covered work. These actions infringe copyright if you do not +accept this License. Therefore, by modifying or propagating a covered work, you +indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients + +Each time you convey a covered work, the recipient automatically receives a license +from the original licensors, to run, modify and propagate that work, subject to this +License. You are not responsible for enforcing compliance by third parties with this +License. + +An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an organization, or +merging organizations. If propagation of a covered work results from an entity +transaction, each party to that transaction who receives a copy of the work also +receives whatever licenses to the work the party's predecessor in interest had or +could give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if the predecessor +has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights granted or +affirmed under this License. For example, you may not impose a license fee, royalty, +or other charge for exercise of rights granted under this License, and you may not +initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging +that any patent claim is infringed by making, using, selling, offering for sale, or +importing the Program or any portion of it. + +### 11. Patents + +A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The work thus +licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims owned or +controlled by the contributor, whether already acquired or hereafter acquired, that +would be infringed by some manner, permitted by this License, of making, using, or +selling its contributor version, but do not include claims that would be infringed +only as a consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant patent +sublicenses in a manner consistent with the requirements of this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license +under the contributor's essential patent claims, to make, use, sell, offer for sale, +import and otherwise run, modify and propagate the contents of its contributor +version. + +In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent (such as an +express permission to practice a patent or covenant not to sue for patent +infringement). To “grant” such a patent license to a party means to make +such an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free of charge +and under the terms of this License, through a publicly available network server or +other readily accessible means, then you must either **(1)** cause the Corresponding +Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the +patent license for this particular work, or **(3)** arrange, in a manner consistent with +the requirements of this License, to extend the patent license to downstream +recipients. “Knowingly relying” means you have actual knowledge that, but +for the patent license, your conveying the covered work in a country, or your +recipient's use of the covered work in a country, would infringe one or more +identifiable patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you +convey, or propagate by procuring conveyance of, a covered work, and grant a patent +license to some of the parties receiving the covered work authorizing them to use, +propagate, modify or convey a specific copy of the covered work, then the patent +license you grant is automatically extended to all recipients of the covered work and +works based on it. + +A patent license is “discriminatory” if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on the +non-exercise of one or more of the rights that are specifically granted under this +License. You may not convey a covered work if you are a party to an arrangement with +a third party that is in the business of distributing software, under which you make +payment to the third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties who would receive +the covered work from you, a discriminatory patent license **(a)** in connection with +copies of the covered work conveyed by you (or copies made from those copies), or **(b)** +primarily for and in connection with specific products or compilations that contain +the covered work, unless you entered into that arrangement, or that patent license +was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available to you +under applicable patent law. + +### 12. No Surrender of Others' Freedom + +If conditions are imposed on you (whether by court order, agreement or otherwise) +that contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot convey a covered work so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not convey it at all. For example, if you +agree to terms that obligate you to collect a royalty for further conveying from +those to whom you convey the Program, the only way you could satisfy both those terms +and this License would be to refrain entirely from conveying the Program. + +### 13. Use with the GNU Affero General Public License + +Notwithstanding any other provision of this License, you have permission to link or +combine any covered work with a work licensed under version 3 of the GNU Affero +General Public License into a single combined work, and to convey the resulting work. +The terms of this License will continue to apply to the part which is the covered +work, but the special requirements of the GNU Affero General Public License, section +13, concerning interaction through a network will apply to the combination as such. + +### 14. Revised Versions of this License + +The Free Software Foundation may publish revised and/or new versions of the GNU +General Public License from time to time. Such new versions will be similar in spirit +to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies that +a certain numbered version of the GNU General Public License “or any later +version” applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published by the +Free Software Foundation. If the Program does not specify a version number of the GNU +General Public License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the GNU +General Public License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the Program. + +Later license versions may give you additional or different permissions. However, no +additional obligations are imposed on any author or copyright holder as a result of +your choosing to follow a later version. + +### 15. Disclaimer of Warranty + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE +QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +### 16. Limitation of Liability + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY +COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS +PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE +OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE +WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16 + +If the disclaimer of warranty and limitation of liability provided above cannot be +given local legal effect according to their terms, reviewing courts shall apply local +law that most closely approximates an absolute waiver of all civil liability in +connection with the Program, unless a warranty or assumption of liability accompanies +a copy of the Program in return for a fee. + +_END OF TERMS AND CONDITIONS_ + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible use to +the public, the best way to achieve this is to make it free software which everyone +can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach them +to the start of each source file to most effectively state the exclusion of warranty; +and each file should have at least the “copyright” line and a pointer to +where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short notice like this +when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type 'show c' for details. + +The hypothetical commands `show w` and `show c` should show the appropriate parts of +the General Public License. Of course, your program's commands might be different; +for a GUI interface, you would use an “about box”. + +You should also get your employer (if you work as a programmer) or school, if any, to +sign a “copyright disclaimer” for the program, if necessary. For more +information on this, and how to apply and follow the GNU GPL, see +<>. + +The GNU General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may consider it +more useful to permit linking proprietary applications with the library. If this is +what you want to do, use the GNU Lesser General Public License instead of this +License. But first, please read +<>. diff --git a/R/cookies.R b/R/cookies.R index 0da917f..e4dd18f 100644 --- a/R/cookies.R +++ b/R/cookies.R @@ -34,24 +34,29 @@ dfe_cookie_script <- function() { #' @export #' #' @examples -#' To use the banner, first copy the file cookie-consent.js from the js/ folder -#' of this package to the www/ folder of your R-Shiny app. Then add the -#' following lines to your ui.R: -#' dfe_cookie_script(), -#' cookie_banner_ui("cookies", name = "My DfE R-Shiny data dashboard"), -#' -#' And add the following in server.R (after updating the google analytics key): -#' output$cookie_status <- dfeshiny::cookie_banner_server( +#' \donttest{ +#' # To use the banner, first copy the file cookie-consent.js from the +#' # js/ folder of this package to the www/ folder of your R-Shiny app. +#' # Then add the following lines to your ui.R: +#' \dontrun{dfe_cookie_script(),} +#' \dontrun{ +#' cookie_banner_ui("cookies", name = "My DfE R-Shiny data dashboard") +#' } +#' +#' # And add the following in server.R +#' # (after updating the google analytics key): +#' \dontrun{output$cookie_status <- dfeshiny::cookie_banner_server( #' "cookies", #' input_cookies = reactive(input$cookies), #' input_clear = reactive(input$cookie_consent_clear), #' parent_session = session, #' google_analytics_key = "ABCDE12345" #' ) +#' } #' -#' Note that you should also include dfeshiny::support_panel() in your -#' navListPanel() -#' +#' # Note that you should also include dfeshiny::support_panel() in your +#' # navListPanel() +#' } cookie_banner_ui <- function(id, name = "DfE R-Shiny dashboard template") { shiny::tags$div( id = shiny::NS(id, "cookie_div"), @@ -115,7 +120,8 @@ cookie_banner_ui <- function(id, name = "DfE R-Shiny dashboard template") { #' @param input_cookies The cookie input passed from cookies.js (should always #' be reactive(input$cookies)) #' @param input_clear The state of the cookie reset button provided by -#' dfeshiny::support_panel(). Should always be set to reactive(input$cookie_consent_clear). +#' dfeshiny::support_panel(). +#' Should always be set to reactive(input$cookie_consent_clear). #' @param parent_session This should be the R Shiny app session #' @param google_analytics_key Provide the GA 10 digit key of the form #' "ABCDE12345" @@ -124,24 +130,30 @@ cookie_banner_ui <- function(id, name = "DfE R-Shiny dashboard template") { #' @export #' #' @examples -#' To use the banner, first copy the file cookie-consent.js from the js/ folder -#' of this package to the www/ folder of your R-Shiny app. Then add the -#' following lines to your ui.R: -#' dfe_cookie_script(), -#' cookie_banner_ui("cookies", name = "My DfE R-Shiny data dashboard"), -#' -#' And add the following in server.R (after updating the google analytics key): -#' output$cookie_status <- dfeshiny::cookie_banner_server( +#' \donttest{ +#' #' To use the banner, first copy the file cookie-consent.js from the +#' # inst/ folder of this package to the www/ folder of your R-Shiny app. +#' # Then add the following lines to your ui.R: +#' \dontrun{dfe_cookie_script(),} +#' \dontrun{ +#' cookie_banner_ui("cookies", name = "My DfE R-Shiny data dashboard") +#' } +#' +#' # And add the following in server.R +#' # (after updating the google analytics key): +#' \dontrun{output$cookie_status <- dfeshiny::cookie_banner_server( #' "cookies", #' input_cookies = reactive(input$cookies), #' input_clear = reactive(input$cookie_consent_clear), #' parent_session = session, #' google_analytics_key = "ABCDE12345" #' ) +#' } #' -#' Note that you should also include dfeshiny::support_panel() in your -#' navListPanel() -#' +#' # Note that you should also include `dfeshiny::support_panel()` in your +#' # `navListPanel()` +#' } + cookie_banner_server <- function( id, input_cookies, diff --git a/R/standard_panels.R b/R/standard_panels.R deleted file mode 100644 index f587557..0000000 --- a/R/standard_panels.R +++ /dev/null @@ -1,145 +0,0 @@ -library(shiny) -library(shinyGovstyle) - -#' Support panel -#' -#' @description -#' Create the standard DfE R-Shiny support and feedback dashboard panel. -#' -#' @param team_email Your team e-mail address as a string -#' @param repo_name The repository name as listed on GitHub -#' @param ees_publication Whether the parent publication is hosted on Explore -#' Education Statistics -#' @param publication_name The parent publication name -#' @param publication_stub The parent publication stub on Explore Education -#' Statistics -#' @param alt_href Alternative link to the parent publication (if not hosted on -#' Explore Education Statistics) -#' @param form_url URL to a feedback form for the dashboard -#' -#' @return -#' @export -#' -#' @examples -support_panel <- function( - team_email = "", - repo_name = "", - ees_publication = TRUE, - publication_name = NULL, - publication_stub = "", - alt_href = NULL, - form_url = NULL) { - tabPanel( - value = "support_panel", - "Support and feedback", - gov_main_layout( - gov_row( - column( - width = 12, - h1("Support and feedback"), - h2("Give us feedback"), - if (!is.null(form_url)) { - p( - "This dashboard is a new service that we are developing. If you - have any feedback or suggestions for improvements, please submit - them using our ", - a(href = form_url, "feedback form", .noWS = c("after")) - ) - } else { - p("This dashboard is a new service that we are developing.") - }, - p( - paste0( - ifelse( - !is.null(form_url), - "Alternatively, i", - "I" - ), - "f you spot any errors or bugs while using this dashboard, please - screenshot and email them to " - ), - tags$a( - href = paste0("mailto:", team_email), - team_email, - .noWS = c("after") - ), "." - ), - h2("Find more information on the data"), - if (ees_publication) { - p( - "The parent statistical release of this dashboard, along with - methodological information, is available at the following link: ", - tags$a( - href = paste0( - "https://explore-education-statistics.service.gov.uk/find-statistics/", - publication_stub - ), - ifelse( - !is.null(publication_name), - publication_name, - "Explore Education Statistics" - ), - .noWS = c("after") - ), - ". The statistical release provides additional ", - tags$a( - href = paste0( - "https://explore-education-statistics.service.gov.uk/find-statistics/", - publication_stub, "/data guidance" - ), - "data guidance", - .noWS = c("after") - ), - " and ", - tags$a( - href = paste0( - "https://explore-education-statistics.service.gov.uk/find-statistics/", - publication_stub, "#explore-data-and-files" - ), - "tools to access and interogate the underling data", - .noWS = c("after") - ), - " contained in this dashboard." - ) - } else { - p( - "The parent statistical release of this dashboard, along with - methodological information, is available at the following link: ", - a( - href = alt_href, - publication_name, - .noWS = c("after") - ) - ) - }, - h2("Contact us"), - p( - "If you have questions about the dashboard or data within it, please - contact us at ", - a( - href = paste0("mailto:", team_email), - team_email, .noWS = c("after") - ) - ), - h2("See the source code"), - p( - "The source code for this dashboard is available in our ", - a( - href = paste0( - "https://github.com/dfe-analytical-services/", repo_name - ), - "GitHub repository", .noWS = c("after") - ), - "." - ), - h2("Use of cookies"), - p("To better understand the reach of our dashboard tools, this site - uses cookies to identify numbers of unique users as part of Google - Analytics."), - textOutput("cookie_status"), - actionButton("cookie_consent_clear", "Reset cookie consent"), - ) - ) - ) - ) -} diff --git a/R/support_panel.R b/R/support_panel.R new file mode 100644 index 0000000..4d191a6 --- /dev/null +++ b/R/support_panel.R @@ -0,0 +1,204 @@ +#' Support panel +#' +#' @description +#' Create the standard DfE R-Shiny support and feedback dashboard panel. +#' +#' @param team_email Your team e-mail address, must be a education.gov.uk email +#' @param repo_name The repository name as listed on GitHub +#' @param ees_publication Whether the parent publication is hosted on Explore +#' Education Statistics +#' @param publication_name The parent publication name +#' @param publication_slug The parent publication slug on Explore Education +#' Statistics +#' @param alt_href Alternative link to the parent publication (if not hosted on +#' Explore Education Statistics) +#' @param form_url URL to a feedback form for the dashboard +#' @param cookie_status_output Name of cookie status output object, often +#' "cookie_status" +#' +#' @return a standardised panel for a public R Shiny dashboard in DfE +#' @export +#' +#' @examples +#' support_panel( +#' team_email = "my.team@@education.gov.uk", +#' repo_name = "https://github.com/dfe-analytical-services/my-repo", +#' publication_name = "My publication title", +#' publication_slug = "my-publication-title", +#' form_url = "www.myform.com", +#' cookie_status_output = "cookie_status" +#' ) +support_panel <- function( + team_email = "", + repo_name = "", + ees_publication = TRUE, + publication_name = NULL, + publication_slug = "", + alt_href = NULL, + form_url = NULL, + cookie_status_output = "cookie_status") { + # Check that the team_email is a valid dfe email ---------------------------- + is_valid_dfe_email <- function(email) { + grepl( + "\\<[A-Z0-9._%+-]+@education.gov.uk\\>", + as.character(email), + ignore.case = TRUE + ) + } + + if (is_valid_dfe_email(team_email) == FALSE) { + stop( + "You have entered an invalid email in the team_email argument. + Please enter an @education.gov.uk email." + ) + } + + # Check that the repo_name is a valid dfe repo ------------------------------ + # TODO: Use RCurl to check another step further, if the URL is valid + is_valid_repo_name <- function(url) { + grepl( + "\\https://github.com/dfe-analytical-services/+.", + as.character(url), + ignore.case = TRUE + ) + } + + if (repo_name == "") { + stop( + "The repo_name argument is empty, please specify a value for repo_name" + ) + } + + if (is_valid_repo_name(repo_name) == FALSE) { + stop( + "Please ensure the repo_name argument points to a repository on the + dfe-analytical-services GitHub area." + ) + } + + # Build the support page ---------------------------------------------------- + shiny::tabPanel( + value = "support_panel", + "Support and feedback", + shinyGovstyle::gov_main_layout( + shinyGovstyle::gov_row( + shiny::column( + width = 12, + shiny::tags$h1("Support and feedback"), + shiny::tags$h2("Give us feedback"), + if (!is.null(form_url)) { + shiny::tags$p( + "This dashboard is a new service that we are developing. If you + have any feedback or suggestions for improvements, please submit + them using our ", + shiny::tags$a( + href = form_url, + "feedback form", + .noWS = c("after") + ) + ) + } else { + shiny::tags$p( + "This dashboard is a new service that we are developing." + ) + }, + shiny::tags$p( + paste0( + ifelse( + !is.null(form_url), + "Alternatively, i", + "I" + ), + "f you spot any errors or bugs while using this dashboard, please + screenshot and email them to " + ), + shiny::tags$a( + href = paste0("mailto:", team_email), + team_email, + .noWS = c("after") + ), "." + ), + shiny::tags$h2("Find more information on the data"), + if (ees_publication) { + shiny::tags$p( + "The parent statistical release of this dashboard, along with + methodological information, + is available at the following link: ", + shiny::tags$a( + href = paste0( + "https://explore-education-statistics.service.gov.uk/ + find-statistics/", + publication_slug + ), + ifelse( + !is.null(publication_name), + publication_name, + "Explore Education Statistics" + ), + .noWS = c("after") + ), + ". The statistical release provides additional ", + shiny::tags$a( + href = paste0( + "https://explore-education-statistics.service.gov.uk/ + find-statistics/", + publication_slug, "/data guidance" + ), + "data guidance", + .noWS = c("after") + ), + " and ", + shiny::tags$a( + href = paste0( + "https://explore-education-statistics.service.gov.uk/ + find-statistics/", + publication_slug, "#explore-data-and-files" + ), + "tools to access and interogate the underling data", + .noWS = c("after") + ), + " contained in this dashboard." + ) + } else { + shiny::tags$p( + "The parent statistical release of this dashboard, along with + methodological information, + is available at the following link: ", + shiny::tags$a( + href = alt_href, + publication_name, + .noWS = c("after") + ) + ) + }, + shiny::tags$h2("Contact us"), + shiny::tags$p( + "If you have questions about the dashboard or data within it, + please contact us at ", + shiny::tags$a( + href = paste0("mailto:", team_email), + team_email, .noWS = c("after") + ) + ), + shiny::tags$h2("See the source code"), + shiny::tags$p( + "The source code for this dashboard is available in our ", + shiny::tags$a( + href = paste0( + repo_name + ), + "GitHub repository", .noWS = c("after") + ), + "." + ), + shiny::tags$h2("Use of cookies"), + shiny::tags$p("To better understand the reach of our dashboard tools, + this site uses cookies to identify numbers of unique users + as part of Google Analytics."), + shiny::textOutput(cookie_status_output), + shiny::actionButton("cookie_consent_clear", "Reset cookie consent"), + ) + ) + ) + ) +} diff --git a/R/testing.R b/R/tidy_code.R similarity index 60% rename from R/testing.R rename to R/tidy_code.R index f1dcfba..ad1c713 100644 --- a/R/testing.R +++ b/R/tidy_code.R @@ -1,13 +1,16 @@ #' Tidy code #' -#' @description Script to apply styler code styling to scripts within the shiny directory structure. +#' @description Script to apply styler code styling to scripts within the +#' shiny directory structure. #' -#' @param subdirs List of sub-directories to (recursively search for R scripts to be styled) +#' @param subdirs List of sub-directories to +#' (recursively search for R scripts to be styled) #' -#' @return +#' @return True or False value based on if scripts were changed #' @export #' #' @examples +#' tidy_code() tidy_code <- function(subdirs = c("R", "tests")) { message("----------------------------------------") message("App scripts") @@ -17,13 +20,19 @@ tidy_code <- function(subdirs = c("R", "tests")) { if (dir.exists(dir)) { message(paste(dir, "scripts")) message("----------------------------------------") - script_changes <- c(script_changes, eval(styler::style_dir(dir)$changed)) + script_changes <- c( + script_changes, + eval(styler::style_dir(dir)$changed) + ) } else { warning(paste("Script directory not found:", dir, "- Skipping!")) } } if (any(script_changes)) { - message("Styling changes have been made to your scripts, please review any changes made.") + message( + "Styling changes have been made to your scripts, + please review any changes made." + ) } return(any(script_changes)) } diff --git a/README.md b/README.md index 4dabafc..0caeb53 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,22 @@ + +[![R-CMD-check](https://github.com/dfe-analytical-services/dfeshiny/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dfe-analytical-services/dfeshiny/actions/workflows/R-CMD-check.yaml) +[![Codecov test coverage](https://codecov.io/gh/dfe-analytical-services/dfeshiny/branch/main/graph/badge.svg)](https://app.codecov.io/gh/dfe-analytical-services/dfeshiny?branch=main) + + # dfeshiny R package containing preferred methods for creating official DfE R-Shiny dashboards +# Installing the package +To install, run `renv::install("dfe-analytical-services/dfeshiny")`. + +## Potential errors when installing +If you get `ERROR [curl: (22) The requested URL returned error: 401]`, and don't know why, try running `Sys.unsetenv("GITHUB_PAT")` to temporarily clear your GitHub PAT variable. + +Then try to install again. + +If this works, then you will need to look for where that "GITHUB_PAT" variable is being set from and remove it to permanently fix the issue, contact us for support if you need help with this or have any other issues installing. + ## Using this package in a DfE data dashboard ### Adding cookies to your dashboard @@ -67,18 +82,48 @@ to change their decision on whether or not to accept the use of cookies. 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()` This will create a new script within the package R/ folder. -### Creating a new script +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 = )` This will create a new script within the package R/ folder. +### Creating a new function test script + +`usethis::use_test(name = )` + +This will create a new 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 @@ -86,14 +131,21 @@ can increment the package version using: `usethis::use_version()` -Once you've incremented the version number, it'll offer to perform a commit on your behalf, so all you then need to do is push to GitHub. +Once you've incremented the version number, it'll add a new heading to news.md. -# Installing the package -To install, run `renv::install("dfe-analytical-services/dfeshiny")`. +Add a summary under news.md and then accept it's offer to commit on your behalf. -## Potential errors when installing -If you get `ERROR [curl: (22) The requested URL returned error: 401]`, and don't know why, try running `Sys.unsetenv("GITHUB_PAT")` to temporarily clear your GitHub PAT variable. +Once pushed and on the main branch, create a new release in GitHub itself. -Then try to install again. +### Running tests -If this works, then you will need to look for where that "GITHUB_PAT" variable is being set from and remove it to permanently fix the issue, contact us for support if you need help with this or have any other issues installing. +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, need to move this over + +# For code styling +styler::style_pkg() # currently has a known error on cookies.R +lintr::lint_package() +``` diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..04c5585 --- /dev/null +++ b/codecov.yml @@ -0,0 +1,14 @@ +comment: false + +coverage: + status: + project: + default: + target: auto + threshold: 1% + informational: true + patch: + default: + target: auto + threshold: 1% + informational: true diff --git a/js/cookie-consent.js b/inst/cookie-consent.js similarity index 100% rename from js/cookie-consent.js rename to inst/cookie-consent.js diff --git a/man/cookie_banner_server.Rd b/man/cookie_banner_server.Rd index e09179b..d0ca57f 100644 --- a/man/cookie_banner_server.Rd +++ b/man/cookie_banner_server.Rd @@ -19,7 +19,8 @@ cookie_banner_server( be reactive(input$cookies))} \item{input_clear}{The state of the cookie reset button provided by -dfeshiny::support_panel(). Should always be set to reactive(input$cookie_consent_clear).} +dfeshiny::support_panel(). +Should always be set to reactive(input$cookie_consent_clear).} \item{parent_session}{This should be the R Shiny app session} @@ -32,31 +33,29 @@ cookie_banner_ui(). Place cookie_banner_server() as a call in your server.R file to provide the server functions to control users being able to accept or reject cookie consent for the provision of Google Analytics tracking on DfE R-Shiny dashboards. - -To use the banner, first copy the file cookie-consent.js from the js/ folder -of this package to the www/ folder of your R-Shiny app. Then add the -following lines to your ui.R: -dfe_cookie_script() -cookie_banner_ui("cookies", name = "My DfE R-Shiny data dashboard") - -And add the following in server.R (after updating the google analytics key): -output$cookie_status <- dfeshiny::cookie_banner_server( -"cookies", -input_cookies = reactive(input$cookies), -input_clear = reactive(input$cookie_consent_clear), -parent_session = session, -google_analytics_key = "ABCDE12345" -) - -Note that you should also include dfeshiny::support_panel() in your -navListPanel() } \examples{ -output$cookie_status <- cookie_banner_server( +\donttest{ +#' To use the banner, first copy the file cookie-consent.js from the +# inst/ folder of this package to the www/ folder of your R-Shiny app. +# Then add the following lines to your ui.R: +\dontrun{dfe_cookie_script(),} +\dontrun{ +cookie_banner_ui("cookies", name = "My DfE R-Shiny data dashboard") +} + +# And add the following in server.R +# (after updating the google analytics key): +\dontrun{output$cookie_status <- dfeshiny::cookie_banner_server( "cookies", input_cookies = reactive(input$cookies), input_clear = reactive(input$cookie_consent_clear), parent_session = session, - google_analytics_key = "" -) + google_analytics_key = "ABCDE12345" + ) + } + +# Note that you should also include `dfeshiny::support_panel()` in your +# `navListPanel()` +} } diff --git a/man/cookie_banner_ui.Rd b/man/cookie_banner_ui.Rd index 271a289..2e92eac 100644 --- a/man/cookie_banner_ui.Rd +++ b/man/cookie_banner_ui.Rd @@ -20,25 +20,29 @@ This function provides a cookie authorisation banner on DfE R-Shiny dashboards for users to be able to accept or reject cookies. The server side functionality is provided by cookie_banner_server(), whilst users will also need to include the dfe_cookie_script() function in their ui.R file. - -To use the banner, first copy the file cookie-consent.js from the js/ folder -of this package to the www/ folder of your R-Shiny app. Then add the -following lines to your ui.R: -dfe_cookie_script() +} +\examples{ +\donttest{ +# To use the banner, first copy the file cookie-consent.js from the +# js/ folder of this package to the www/ folder of your R-Shiny app. +# Then add the following lines to your ui.R: +\dontrun{dfe_cookie_script(),} +\dontrun{ cookie_banner_ui("cookies", name = "My DfE R-Shiny data dashboard") +} -And add the following in server.R (after updating the google analytics key): -output$cookie_status <- dfeshiny::cookie_banner_server( -"cookies", -input_cookies = reactive(input$cookies), -input_clear = reactive(input$cookie_consent_clear), -parent_session = session, -google_analytics_key = "ABCDE12345" -) +# And add the following in server.R +# (after updating the google analytics key): +\dontrun{output$cookie_status <- dfeshiny::cookie_banner_server( + "cookies", + input_cookies = reactive(input$cookies), + input_clear = reactive(input$cookie_consent_clear), + parent_session = session, + google_analytics_key = "ABCDE12345" + ) + } -Note that you should also include dfeshiny::support_panel() in your -navListPanel() +# Note that you should also include dfeshiny::support_panel() in your +# navListPanel() } -\examples{ -cookie_banner_ui("cookies", name = "My DfE R-Shiny data dashboard") } diff --git a/man/support_panel.Rd b/man/support_panel.Rd index d277d53..3b201d4 100644 --- a/man/support_panel.Rd +++ b/man/support_panel.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/standard_panels.R +% Please edit documentation in R/support_panel.R \name{support_panel} \alias{support_panel} \title{Support panel} @@ -9,13 +9,14 @@ support_panel( repo_name = "", ees_publication = TRUE, publication_name = NULL, - publication_stub = "", + publication_slug = "", alt_href = NULL, - form_url = NULL + form_url = NULL, + cookie_status_output = "cookie_status" ) } \arguments{ -\item{team_email}{Your team e-mail address as a string} +\item{team_email}{Your team e-mail address, must be a education.gov.uk email} \item{repo_name}{The repository name as listed on GitHub} @@ -24,14 +25,30 @@ Education Statistics} \item{publication_name}{The parent publication name} -\item{publication_stub}{The parent publication stub on Explore Education +\item{publication_slug}{The parent publication slug on Explore Education Statistics} \item{alt_href}{Alternative link to the parent publication (if not hosted on Explore Education Statistics)} \item{form_url}{URL to a feedback form for the dashboard} + +\item{cookie_status_output}{Name of cookie status output object, often +"cookie_status"} +} +\value{ +a standardised panel for a public R Shiny dashboard in DfE } \description{ Create the standard DfE R-Shiny support and feedback dashboard panel. } +\examples{ +support_panel( + team_email = "my.team@education.gov.uk", + repo_name = "https://github.com/dfe-analytical-services/my-repo", + publication_name = "My publication title", + publication_slug = "my-publication-title", + form_url = "www.myform.com", + cookie_status_output = "cookie_status" +) +} diff --git a/man/tidy_code.Rd b/man/tidy_code.Rd index c17aeb0..d838c46 100644 --- a/man/tidy_code.Rd +++ b/man/tidy_code.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/testing.R +% Please edit documentation in R/tidy_code.R \name{tidy_code} \alias{tidy_code} \title{Tidy code} @@ -7,8 +7,16 @@ tidy_code(subdirs = c("R", "tests")) } \arguments{ -\item{subdirs}{List of sub-directories to (recursively search for R scripts to be styled)} +\item{subdirs}{List of sub-directories to +(recursively search for R scripts to be styled)} +} +\value{ +True or False value based on if scripts were changed } \description{ -Script to apply styler code styling to scripts within the shiny directory structure. +Script to apply styler code styling to scripts within the +shiny directory structure. +} +\examples{ +tidy_code() } diff --git a/tests/test_dashboard/global.R b/tests/test_dashboard/global.R index 71bce34..0ad3c3b 100644 --- a/tests/test_dashboard/global.R +++ b/tests/test_dashboard/global.R @@ -1,5 +1,4 @@ library(shiny) -message(getwd()) devtools::load_all(path = "../../") google_analytics_key <- "ABCDE12345" diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-001_.png b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-001_.png deleted file mode 100644 index 7ddc649..0000000 Binary files a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-001_.png and /dev/null differ diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-002_.png b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-002_.png deleted file mode 100644 index c7bb919..0000000 Binary files a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-002_.png and /dev/null differ diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-003_.png b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-003_.png deleted file mode 100644 index 7ddc649..0000000 Binary files a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-003_.png and /dev/null differ diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-004_.png b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-004_.png deleted file mode 100644 index ac84b93..0000000 Binary files a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-004_.png and /dev/null differ diff --git a/tests/test_dashboard/tests/testthat/setup-shinytest2.R b/tests/test_dashboard/tests/testthat/setup-shinytest2.R index a329c7d..be65b4f 100644 --- a/tests/test_dashboard/tests/testthat/setup-shinytest2.R +++ b/tests/test_dashboard/tests/testthat/setup-shinytest2.R @@ -1,4 +1,2 @@ # Load application support files into testing environment -# To run the shiny tests, use this command from the package route directory: -# shinytest2::test_app(app_dir='tests/test_dashboard/') shinytest2::load_app_env() diff --git a/tests/test_dashboard/tests/testthat/test-cookie-auth.R b/tests/test_dashboard/tests/testthat/test-cookie-auth.R index 5ab634b..5ca791b 100644 --- a/tests/test_dashboard/tests/testthat/test-cookie-auth.R +++ b/tests/test_dashboard/tests/testthat/test-cookie-auth.R @@ -1,7 +1,8 @@ library(shinytest2) # To run the diffviewer on these tests, you need to add the path: -# testthat::snapshot_review('cookie-auth/', path='tests/test_dashboard/') +# Doesn't work? testthat::snapshot_review('cookie-auth/', +# path='tests/test_dashboard/') app <- AppDriver$new( name = "cookie_consent", @@ -9,7 +10,8 @@ app <- AppDriver$new( width = 1445, load_timeout = 45 * 1000, timeout = 20 * 1000, - wait = TRUE + wait = TRUE, + expect_values_screenshot_args = FALSE ) app$wait_for_idle(500) diff --git a/tests/test_dashboard/ui.R b/tests/test_dashboard/ui.R index 2c8acf3..8fdd09f 100644 --- a/tests/test_dashboard/ui.R +++ b/tests/test_dashboard/ui.R @@ -10,7 +10,7 @@ ui <- function(input, output, session) { well = FALSE, support_panel( team_email = "statistics.development@education.gov.uk", - repo_name = "dfeshiny", + repo_name = "https://github.com/dfe-analytical-services/dfeshiny/", form_url = "https://forms.office.com" ) ) diff --git a/tests/testthat.R b/tests/testthat.R new file mode 100644 index 0000000..775784f --- /dev/null +++ b/tests/testthat.R @@ -0,0 +1,12 @@ +# This file is part of the standard setup for testthat. +# It is recommended that you do not modify it. +# +# Where should you do additional test configuration? +# Learn more about the roles of various files in: +# * https://r-pkgs.org/testing-design.html#sec-tests-files-overview +# * https://testthat.r-lib.org/articles/special-files.html + +library(testthat) +library(dfeshiny) + +test_check("dfeshiny") diff --git a/tests/testthat/test-support_panel.R b/tests/testthat/test-support_panel.R new file mode 100644 index 0000000..948974b --- /dev/null +++ b/tests/testthat/test-support_panel.R @@ -0,0 +1,92 @@ +test_that("email needs to follow standard pattern", { + # Test that a @education.gov.uk passes + expect_no_error( + support_panel( + team_email = "cam@education.gov.uk", + repo_name = "https://github.com/dfe-analytical-services/dfeshiny" + ) + ) + expect_no_error( + support_panel( + team_email = "cam1.race@education.gov.uk", + repo_name = "https://github.com/dfe-analytical-services/dfeshiny" + ) + ) + + # Testing that it will fail if it follows the something@domain.ending pattern + expect_error( + support_panel( + team_email = "thisshouldpass@something.com", + repo_name = "https://github.com/dfe-analytical-services/dfeshiny" + ) + ) + expect_error( + support_panel( + team_email = "this.should.pass@something.com", + repo_name = "https://github.com/dfe-analytical-services/dfeshiny" + ) + ) + + # Testing that it will fail if there is no final dot and section + expect_error( + support_panel( + team_email = "thisshoulfail@something", + repo_name = "https://github.com/dfe-analytical-services/dfeshiny" + ) + ) + + # Test Wales will fail + expect_error( + support_panel( + team_email = "thisshouldpass@something.wales", + repo_name = "https://github.com/dfe-analytical-services/dfeshiny" + ) + ) + + # Test that it fails if there is no @ symbol + expect_error( + support_panel( + team_email = "team.team", + repo_name = "https://github.com/dfe-analytical-services/dfeshiny" + ) + ) +}) + +test_that("repo URL needs to follow standard pattern", { + # Test that a github repo in dfe analytical services passes + expect_no_error( + support_panel( + team_email = "cam@education.gov.uk", + repo_name = "https://github.com/dfe-analytical-services/dfeshiny" + ) + ) + + # Testing that it will fail if it's on GitHub but not in DfE area + expect_error( + support_panel( + team_email = "cam@education.gov.uk", + repo_name = "https://github.com/cjrace/dfeR" + ) + ) + expect_error( + support_panel( + team_email = "cam@education.gov.uk", + repo_name = "https://github.com/DfE-R-Community/ggdfe" + ) + ) + + # Testing that it will fail if there is no final dot and section + expect_error( + support_panel( + team_email = "cam@education.gov.uk", + repo_name = "https://explore-education-statistics.service.gov.uk/" + ) + ) + + # Testing that it will fail if there is no repo_name + expect_error( + support_panel( + team_email = "cam@education.gov.uk" + ) + ) +})