add codemate.json

.Rbuildignore

@@ -7,3 +7,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^codemeta\.json$

DESCRIPTION

@@ -12,6 +12,7 @@ RoxygenNote: 7.3.2
 Imports: 
     cli,
     dplyr,
+    lifecycle,
     waldo
 Suggests: 
     knitr,

NAMESPACE

@@ -3,3 +3,4 @@
 export(catch)
 export(loupe)
 export(release)
+importFrom(lifecycle,deprecated)

R/butterfly-package.R

@@ -0,0 +1,7 @@
+#' @keywords internal
+"_PACKAGE"
+
+## usethis namespace: start
+#' @importFrom lifecycle deprecated
+## usethis namespace: end
+NULL

README.Rmd

@@ -18,6 +18,7 @@ knitr::opts_chunk$set(
 <!-- badges: start -->
 [![R-CMD-check](https://github.com/thomaszwagerman/butterfly/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/thomaszwagerman/butterfly/actions/workflows/R-CMD-check.yaml)
 [![Codecov test coverage](https://codecov.io/gh/thomaszwagerman/butterfly/branch/main/graph/badge.svg)](https://app.codecov.io/gh/thomaszwagerman/butterfly?branch=main)
+[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 <!-- badges: end -->
 
 The goal of butterfly is to aid in the quality assurance of continually updating and overwritten time-series data, where we expect new values over time, but want to ensure previous data remains unchanged. 
@@ -42,7 +43,15 @@ You can install the development version of butterfly from [GitHub](https://githu
 devtools::install_github("thomaszwagerman/butterfly")
 ```
 
-## Example
+## Overview
+The butterfly package contains the following:
+
+  * `butterfly::loupe()` - examines in detail whether previous values have changed, and reports them using `waldo::compare()`.
+  * `butterfly::catch()` - returns rows which contain previously changed values in a dataframe.
+  * `butterfly::release()` - drops rows which contain previously changed values, and returns a dataframe containing new and unchanged rows.
+  * `butterflycount` - a list of monthly dataframes, which contain fictional butterfly counts for a given date.
+
+## Examples
 
 This is a basic example which shows you how to use butterfly:
 
@@ -114,5 +123,7 @@ There are other R packages and functions which handle object comparison, which m
 
 * [waldo](https://github.com/r-lib/waldo)
 * [diffdf](https://github.com/gowerc/diffdf)
+* [assertr](https://github.com/tonyfischetti/assertr)
+* [daquiri](https://github.com/ropensci/daiquiri/)
 
 Other functions include `all.equal()` or [dplyr](https://github.com/tidyverse/dplyr)'s `setdiff()`

README.md

@@ -8,6 +8,8 @@
 [![R-CMD-check](https://github.com/thomaszwagerman/butterfly/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/thomaszwagerman/butterfly/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/thomaszwagerman/butterfly/branch/main/graph/badge.svg)](https://app.codecov.io/gh/thomaszwagerman/butterfly?branch=main)
+[![Lifecycle:
+experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 <!-- badges: end -->
 
 The goal of butterfly is to aid in the quality assurance of continually
@@ -39,7 +41,20 @@ You can install the development version of butterfly from
 devtools::install_github("thomaszwagerman/butterfly")
 ```
 
-## Example
+## Overview
+
+The butterfly package contains the following:
+
+- `butterfly::loupe()` - examines in detail whether previous values have
+  changed, and reports them using `waldo::compare()`.
+- `butterfly::catch()` - returns rows which contain previously changed
+  values in a dataframe.
+- `butterfly::release()` - drops rows which contain previously changed
+  values, and returns a dataframe containing new and unchanged rows.
+- `butterflycount` - a list of monthly dataframes, which contain
+  fictional butterfly counts for a given date.
+
+## Examples
 
 This is a basic example which shows you how to use butterfly:
 
@@ -197,6 +212,8 @@ which may suit your specific needs better:
 
 - [waldo](https://github.com/r-lib/waldo)
 - [diffdf](https://github.com/gowerc/diffdf)
+- [assertr](https://github.com/tonyfischetti/assertr)
+- [daquiri](https://github.com/ropensci/daiquiri/)
 
 Other functions include `all.equal()` or
 [dplyr](https://github.com/tidyverse/dplyr)’s `setdiff()`

codemeta.json

@@ -0,0 +1,135 @@
+{
+  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
+  "@type": "SoftwareSourceCode",
+  "identifier": "butterfly",
+  "description": "QA/QC of continually updating timeseries data where we expect new values, but want to ensure previous data remains unchanged.",
+  "name": "butterfly: QA/QC For Continually Updating Timeseries Data",
+  "codeRepository": "https://github.com/thomaszwagerman/butterfly",
+  "issueTracker": "https://github.com/thomaszwagerman/butterfly/issues",
+  "license": "https://spdx.org/licenses/MIT",
+  "version": "0.0.0.9000",
+  "programmingLanguage": {
+    "@type": "ComputerLanguage",
+    "name": "R",
+    "url": "https://r-project.org"
+  },
+  "runtimePlatform": "R version 4.4.1 (2024-06-14)",
+  "author": [
+    {
+      "@type": "Person",
+      "givenName": "Thomas",
+      "familyName": "Zwagerman",
+      "email": "[email protected]",
+      "@id": "https://orcid.org/0009-0003-3742-3234"
+    }
+  ],
+  "maintainer": [
+    {
+      "@type": "Person",
+      "givenName": "Thomas",
+      "familyName": "Zwagerman",
+      "email": "[email protected]",
+      "@id": "https://orcid.org/0009-0003-3742-3234"
+    }
+  ],
+  "softwareSuggestions": [
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "knitr",
+      "name": "knitr",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=knitr"
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "rmarkdown",
+      "name": "rmarkdown",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "testthat",
+      "name": "testthat",
+      "version": ">= 3.0.0",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=testthat"
+    }
+  ],
+  "softwareRequirements": {
+    "1": {
+      "@type": "SoftwareApplication",
+      "identifier": "cli",
+      "name": "cli",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=cli"
+    },
+    "2": {
+      "@type": "SoftwareApplication",
+      "identifier": "dplyr",
+      "name": "dplyr",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=dplyr"
+    },
+    "3": {
+      "@type": "SoftwareApplication",
+      "identifier": "lifecycle",
+      "name": "lifecycle",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=lifecycle"
+    },
+    "4": {
+      "@type": "SoftwareApplication",
+      "identifier": "waldo",
+      "name": "waldo",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=waldo"
+    },
+    "5": {
+      "@type": "SoftwareApplication",
+      "identifier": "R",
+      "name": "R",
+      "version": ">= 2.10"
+    },
+    "SystemRequirements": null
+  },
+  "fileSize": "330.734KB",
+  "readme": "https://github.com/thomaszwagerman/butterfly/blob/main/README.md",
+  "contIntegration": ["https://github.com/thomaszwagerman/butterfly/actions/workflows/R-CMD-check.yaml", "https://app.codecov.io/gh/thomaszwagerman/butterfly?branch=main"],
+  "keywords": ["qaqc", "timeseries"]
+}