Project files.

dereckmezquita · Jul 26, 2024 · 39c25f7 · 39c25f7
1 parent e322502
commit 39c25f7
Show file tree

Hide file tree

Showing 8 changed files with 112 additions and 93 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -4,7 +4,6 @@ README.Rmd
 TODO.md
 ^.*\.Rproj$
 ^\.Rproj\.user$
-^\.pre-commit-config\.yaml$
 ^renv$
 ^renv\.lock$
 dev-docs/

diff --git a/.gitignore b/.gitignore
@@ -52,3 +52,6 @@ po/*~
 
 # RStudio Connect folder
 rsconnect/
+
+# machine
+.DS_Store
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: interface
 Type: Package
-Title: Interfaces for data validation and typing in R
+Title: Typings and interfaces for data validation and safety in R
 Version: 0.0.2
 Authors@R: 
     person(given = "Dereck",
@@ -15,6 +15,7 @@ Encoding: UTF-8
 LazyData: true
 VignetteBuilder: knitr
 RoxygenNote: 7.3.2
+Depends: R (>= 4.1.0)
 Suggests:
     testthat (>= 3.0.0),
     knitr,

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
-MIT License
+# MIT License with Citation Requirement
 
-Copyright (c) 2024 Dereck's Projects
+Copyright (c) 2024 Dereck Mezquita, Dereck's Projects
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -12,6 +12,12 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
+Additionally, any use of this Software in commercial, academic or research settings
+must include appropriate citation. The required citation is:
+
+Mezquita, D. (2024). interface. https://github.com/dereckmezquita/interface.
+ORCID: 0000-0002-9307-6762
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -20,12 +20,15 @@ coloursteps
 coord
 coords
 cre
+cryptocurrency
 customising
 dereck
 Dereck
 Dereck's
 dereckmezquita
 derecksnotes
+derecksprojects
+derecksyoutube
 desc
 dev
 dmplot
@@ -70,6 +73,7 @@ MERCHANTABILITY
 mezquita
 Mezquita
 midwest
+Monero
 msleep
 nav
 navbar
@@ -96,6 +100,7 @@ todo
 txhousing
 TypeScript
 TypeScript's
+Typings
 validator
 Validators
 vcs
@@ -104,5 +109,6 @@ visualisation
 visualisations
 Wilke
 www
+youtube
 yutani
 Yutani
diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml
@@ -9,11 +9,30 @@ authors:
 
 navbar:
   structure:
-    right: [search, github]
+    left: [home, reference, articles, donate]
+    right: [github, youtube, search, website]
   components:
+    articles:
+      text: Articles
+      menu:
+      - text: "Getting Started with interface"
+        href: articles/introduction.html
+    donate:
+      text: Donate
+      href: articles/donate.html
     github:
       icon: fa-github fa-lg
       href: https://github.com/dereckmezquita/interface
-    twitter:
-      icon: fa-twitter fa-lg
-      href: https://twitter.com/dereckmezquita
+      target: _blank
+    youtube:
+      icon: fa-youtube fa-lg
+      href: https://www.youtube.com/@derecksyoutube
+      target: _blank
+    website:
+      text: derecksnotes.com
+      href: https://derecksnotes.com
+      target: _blank
+    website:
+      text: derecksprojects.com
+      href: https://derecksprojects.com
+      target: _blank
diff --git a/vignettes/donate.Rmd b/vignettes/donate.Rmd
@@ -0,0 +1,70 @@
+---
+title: "Donate"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Donate}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+<script>
+    function copyToClipboard(elementId) {
+      var element = document.getElementById(elementId);
+      var text = element.innerText;
+      navigator.clipboard.writeText(text).then(function() {
+        console.log('Copying to clipboard was successful!');
+        alert("Copied to clipboard!");
+      }, function(err) {
+        console.error('Could not copy text: ', err);
+      });
+    }
+</script>
+
+
+## Support my work
+
+If you find this package useful, please consider supporting my work with a cryptocurrency donation.
+
+### Bitcoin
+
+<div class="crypto-address">
+  <span id="bitcoin-address">bc1qgs4f6hhnzj8m2j05axgsf53k67kugps92qzr2k</span>
+  <button onclick="copyToClipboard('bitcoin-address')">Copy</button>
+</div>
+
+```{r, echo=FALSE, out.width="50%", fig.align='center'}
+knitr::include_graphics("../man/figures/BITCOIN.png")
+```
+
+### Monero
+
+<div class="crypto-address">
+  <span id="monero-address">41wSUfpnhVUW5GnTKCyBBwVuokhkjMeepAVkKT1qv3HDhcZhTSQx1UaTaibEukndQrCPLVMcRt1LVFpVSq3YrdRjENBtMkG</span>
+  <button onclick="copyToClipboard('monero-address')">Copy</button>
+</div>
+
+```{r, echo=FALSE, out.width="50%", fig.align='center'}
+knitr::include_graphics("../man/figures/MONERO.png")
+```
+
+<style>
+.crypto-address {
+  display: flex;
+  align-items: center;
+  margin-bottom: 10px;
+}
+.crypto-address span {
+  font-family: monospace;
+  padding: 5px;
+  border: 1px solid #ccc;
+  border-radius: 3px;
+  margin-right: 10px;
+}
+.crypto-address button {
+  padding: 5px 10px;
+  background-color: #f0f0f0;
+  border: 1px solid #ccc;
+  border-radius: 3px;
+  cursor: pointer;
+}
+</style>