From 39c25f7380043577aa939bc35074492f533facc4 Mon Sep 17 00:00:00 2001 From: Dereck Mezquita Date: Fri, 26 Jul 2024 10:45:03 -0500 Subject: [PATCH] Project files. --- .Rbuildignore | 1 - .gitignore | 3 ++ .pre-commit-config.yaml | 85 ----------------------------------------- DESCRIPTION | 3 +- LICENSE | 10 ++++- inst/WORDLIST | 6 +++ pkgdown/_pkgdown.yml | 27 +++++++++++-- vignettes/donate.Rmd | 70 +++++++++++++++++++++++++++++++++ 8 files changed, 112 insertions(+), 93 deletions(-) delete mode 100644 .pre-commit-config.yaml create mode 100644 vignettes/donate.Rmd diff --git a/.Rbuildignore b/.Rbuildignore index 589bb5b..b34d40f 100644 --- 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 index 6ba1ac8..e1570af 100644 --- a/.gitignore +++ b/.gitignore @@ -52,3 +52,6 @@ po/*~ # RStudio Connect folder rsconnect/ + +# machine +.DS_Store \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index a7c8e46..0000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,85 +0,0 @@ -# All available hooks: https://pre-commit.com/hooks.html -# R specific hooks: https://github.com/lorenzwalthert/precommit -repos: -- repo: https://github.com/lorenzwalthert/precommit - rev: v0.4.2 - hooks: - - id: readme-rmd-rendered - - id: style-files - args: [--style_pkg=styler, --style_fun=tidyverse_style, --indent_by=4] - exclude: dev/.*| - - id: roxygenize - # codemeta must be above use-tidy-description when both are used - # - id: codemeta-description-updated - - id: use-tidy-description - - id: spell-check - exclude: > - (?x)^( - .*\.[rR]| - .*\.feather| - .*\.jpeg| - .*\.pdf| - .*\.png| - .*\.py| - .*\.RData| - .*\.rds| - .*\.Rds| - .*\.Rproj| - .*\.sh| - (.*/|)\.gitignore| - (.*/|)\.gitlab-ci\.yml| - (.*/|)\.lintr| - (.*/|)\.pre-commit-.*| - (.*/|)\.Rbuildignore| - (.*/|)\.Renviron| - (.*/|)\.Rprofile| - (.*/|)\.travis\.yml| - (.*/|)appveyor\.yml| - (.*/|)NAMESPACE| - (.*/|)renv/settings\.dcf| - (.*/|)renv\.lock| - (.*/|)WORDLIST| - \.github/workflows/.*| - data/.*| - )$ - - id: lintr - args: [--warn_only] - exclude: dev/.*| - - id: parsable-R - exclude: dev/.*| - - id: no-browser-statement - exclude: dev/.*| - - id: no-print-statement - exclude: dev/.*| - - id: no-debug-statement - exclude: dev/.*| - - id: deps-in-desc - exclude: dev/.*| - args: [--allow_private_imports] - - id: pkgdown -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.6.0 - hooks: - - id: check-added-large-files - args: ['--maxkb=200'] - - id: file-contents-sorter - files: '^\.Rbuildignore$' - - id: end-of-file-fixer - exclude: '\.Rd' -- repo: https://github.com/pre-commit-ci/pre-commit-ci-config - rev: v1.6.1 - hooks: - # Only required when https://pre-commit.ci is used for config validation - - id: check-pre-commit-ci-config -- repo: local - hooks: - - id: forbid-to-commit - name: Don't commit common R artifacts - entry: Cannot commit .Rhistory, .RData, .Rds or .rds. - language: fail - files: '\.(Rhistory|RData|Rds|rds)$' - # `exclude: ` to allow committing specific files - -ci: - autoupdate_schedule: monthly - skip: [pkgdown] diff --git a/DESCRIPTION b/DESCRIPTION index 15cca07..167bc94 100644 --- 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 index b7f2d5d..91325b8 100644 --- 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 index 38afdf6..db3b66d 100644 --- 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 index e5c6c09..073f574 100644 --- 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 new file mode 100644 index 0000000..3b80fdc --- /dev/null +++ b/vignettes/donate.Rmd @@ -0,0 +1,70 @@ +--- +title: "Donate" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{Donate} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + + + + +## Support my work + +If you find this package useful, please consider supporting my work with a cryptocurrency donation. + +### Bitcoin + +
+ bc1qgs4f6hhnzj8m2j05axgsf53k67kugps92qzr2k + +
+ +```{r, echo=FALSE, out.width="50%", fig.align='center'} +knitr::include_graphics("../man/figures/BITCOIN.png") +``` + +### Monero + +
+ 41wSUfpnhVUW5GnTKCyBBwVuokhkjMeepAVkKT1qv3HDhcZhTSQx1UaTaibEukndQrCPLVMcRt1LVFpVSq3YrdRjENBtMkG + +
+ +```{r, echo=FALSE, out.width="50%", fig.align='center'} +knitr::include_graphics("../man/figures/MONERO.png") +``` + +