Create software permissions and regulations vignette (#125)

Co-authored-by: pratikunterwegs <[email protected]>
Co-authored-by: GitHub Action <[email protected]>

CITATION.cff

@@ -50,7 +50,7 @@ references:
   - name: R Core Team
   location:
     name: Vienna, Austria
-  year: '2023'
+  year: '2024'
   institution:
     name: R Foundation for Statistical Computing
   version: '>= 3.5.0'
@@ -65,7 +65,7 @@ references:
     given-names: Michel
     email: [email protected]
     orcid: https://orcid.org/0000-0001-9754-0393
-  year: '2023'
+  year: '2024'
 - type: software
   title: stats
   abstract: 'R: A Language and Environment for Statistical Computing'
@@ -74,7 +74,7 @@ references:
   - name: R Core Team
   location:
     name: Vienna, Austria
-  year: '2023'
+  year: '2024'
   institution:
     name: R Foundation for Statistical Computing
 - type: software
@@ -88,7 +88,7 @@ references:
     given-names: Yihui
     email: [email protected]
     orcid: https://orcid.org/0000-0003-0645-5666
-  year: '2023'
+  year: '2024'
 - type: software
   title: data.table
   abstract: 'data.table: Extension of `data.frame`'
@@ -105,7 +105,14 @@ references:
   - family-names: Srinivasan
     given-names: Arun
     email: [email protected]
-  year: '2023'
+  - family-names: Gorecki
+    given-names: Jan
+  - family-names: Chirico
+    given-names: Michael
+  - family-names: Hocking
+    given-names: Toby
+    orcid: https://orcid.org/0000-0002-3146-0865
+  year: '2024'
 - type: software
   title: distcrete
   abstract: 'distcrete: Discrete Distribution Approximations'
@@ -120,7 +127,7 @@ references:
     given-names: Anne
   - family-names: Jombart
     given-names: Thibaut
-  year: '2023'
+  year: '2024'
 - type: software
   title: distributional
   abstract: 'distributional: Vectorised Probability Distributions'
@@ -138,7 +145,7 @@ references:
   - family-names: Hayes
     given-names: Alex
     orcid: https://orcid.org/0000-0002-4985-5160
-  year: '2023'
+  year: '2024'
 - type: software
   title: dplyr
   abstract: 'dplyr: A Grammar of Data Manipulation'
@@ -162,7 +169,7 @@ references:
     given-names: Davis
     email: [email protected]
     orcid: https://orcid.org/0000-0003-4777-038X
-  year: '2023'
+  year: '2024'
 - type: software
   title: forcats
   abstract: 'forcats: Tools for Working with Categorical Variables (Factors)'
@@ -173,7 +180,7 @@ references:
   - family-names: Wickham
     given-names: Hadley
     email: [email protected]
-  year: '2023'
+  year: '2024'
 - type: software
   title: ggplot2
   abstract: 'ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics'
@@ -208,7 +215,7 @@ references:
   - family-names: Dunnington
     given-names: Dewey
     orcid: https://orcid.org/0000-0002-9415-4582
-  year: '2023'
+  year: '2024'
 - type: software
   title: incidence2
   abstract: 'incidence2: Compute, Handle and Plot Incidence of Dated Events'
@@ -220,7 +227,7 @@ references:
     given-names: Tim
     email: [email protected]
     orcid: https://orcid.org/0000-0002-8587-7113
-  year: '2023'
+  year: '2024'
 - type: software
   title: knitr
   abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
@@ -232,7 +239,7 @@ references:
     given-names: Yihui
     email: [email protected]
     orcid: https://orcid.org/0000-0003-0645-5666
-  year: '2023'
+  year: '2024'
 - type: software
   title: purrr
   abstract: 'purrr: Functional Programming Tools'
@@ -247,7 +254,50 @@ references:
   - family-names: Henry
     given-names: Lionel
     email: [email protected]
-  year: '2023'
+  year: '2024'
+- type: software
+  title: rmarkdown
+  abstract: 'rmarkdown: Dynamic Documents for R'
+  notes: Suggests
+  url: https://pkgs.rstudio.com/rmarkdown/
+  repository: https://CRAN.R-project.org/package=rmarkdown
+  authors:
+  - family-names: Allaire
+    given-names: JJ
+    email: [email protected]
+  - family-names: Xie
+    given-names: Yihui
+    email: [email protected]
+    orcid: https://orcid.org/0000-0003-0645-5666
+  - family-names: Dervieux
+    given-names: Christophe
+    email: [email protected]
+    orcid: https://orcid.org/0000-0003-4474-2498
+  - family-names: McPherson
+    given-names: Jonathan
+    email: [email protected]
+  - family-names: Luraschi
+    given-names: Javier
+  - family-names: Ushey
+    given-names: Kevin
+    email: [email protected]
+  - family-names: Atkins
+    given-names: Aron
+    email: [email protected]
+  - family-names: Wickham
+    given-names: Hadley
+    email: [email protected]
+  - family-names: Cheng
+    given-names: Joe
+    email: [email protected]
+  - family-names: Chang
+    given-names: Winston
+    email: [email protected]
+  - family-names: Iannone
+    given-names: Richard
+    email: [email protected]
+    orcid: https://orcid.org/0000-0003-3925-190X
+  year: '2024'
 - type: software
   title: scales
   abstract: 'scales: Scale Functions for Visualization'
@@ -264,7 +314,7 @@ references:
     orcid: https://orcid.org/0000-0002-5147-4711
   - family-names: Seidel
     given-names: Dana
-  year: '2023'
+  year: '2024'
 - type: software
   title: spelling
   abstract: 'spelling: Tools for Spell Checking in R'
@@ -279,7 +329,7 @@ references:
   - family-names: Hester
     given-names: Jim
     email: [email protected]
-  year: '2023'
+  year: '2024'
 - type: software
   title: testthat
   abstract: 'testthat: Unit Testing for R'
@@ -290,7 +340,7 @@ references:
   - family-names: Wickham
     given-names: Hadley
     email: [email protected]
-  year: '2023'
+  year: '2024'
   version: '>= 3.0.0'
 - type: software
   title: tidyr
@@ -307,4 +357,4 @@ references:
     email: [email protected]
   - family-names: Girlich
     given-names: Maximilian
-  year: '2023'
+  year: '2024'

DESCRIPTION

@@ -44,13 +44,14 @@ Suggests:
     incidence2,
     knitr,
     purrr,
+    rmarkdown,
     scales,
     spelling,
     testthat (>= 3.0.0),
     tidyr
 VignetteBuilder: 
     knitr
-Config/Needs/website:epiverse-trace/epiversetheme
+Config/Needs/website: epiverse-trace/epiversetheme
 Config/testthat/edition: 3
 Encoding: UTF-8
 Language: en-GB

_pkgdown.yml

@@ -16,6 +16,10 @@ articles:
   navbar: Handling delay distributions
   contents:
   - delay_distributions
+- title: Software permissions and regulations
+  navbar: Sotware permissions and regulations
+  contents:
+  - software-permissions
 reference:
 - title: Estimating severity
   contents: contains("cfr")

inst/WORDLIST

@@ -30,6 +30,7 @@ PMF
 Piot
 Poisson
 Pratik
+SaMD
 Sherratt
 Tidyverse
 Yahaya

vignettes/software-permissions.Rmd

@@ -0,0 +1,50 @@
+---
+title: "Software permissions and regulations"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Software permissions and regulations}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+This document is not a legally binding contract but presents a simplified
+overview of how this package interacts with the rest of your system, the
+internet, third-party services, etc., and may inform compliance with
+institutional policies or international legislation.
+
+Although this is not a contractual document, we take user rights seriously, and
+welcome any reports of instances where the behaviour of the package does not
+conform with the principles outlined here.
+
+## Scope of regulations
+
+This package IS NOT [Software as Medical Device (SaMD)](https://www.fda.gov/medical-devices/digital-health-center-excellence/software-medical-device-samd).
+
+## Data privacy and integrity
+
+- This package DOES NOT read any data from the user computer
+- This package DOES NOT write any data on the user computer
+- This package DOES NOT interact with external peripherals connected to the user computer (such as, but not limited to: microphone, webcam, printer, etc.)
+
+## Internet access
+
+- This package DOES NOT download data from the internet
+- This package DOES NOT upload data to the internet
+- This package CAN be used offline
+
+## Registration and third parties
+
+- Usage of this package DOES NOT require registration
+- Usage of this package DOES NOT involve third-party services
+- Usage of this package IS NOT restricted to certain geographical regions
+
+## Updates
+
+This package IS NOT automatically updated. Note that this means security updates are not automatically applied.