Skip to content

Commit

Permalink
Prepare for next release
Browse files Browse the repository at this point in the history
  • Loading branch information
nfrerebeau committed Oct 27, 2023
1 parent 84d9e24 commit aa35668
Show file tree
Hide file tree
Showing 11 changed files with 70 additions and 59 deletions.
16 changes: 13 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ message: 'To cite package "arkhe" in publications use:'
type: software
license: GPL-3.0-or-later
title: 'arkhe: Tools for Cleaning Rectangular Data'
version: 1.3.0
version: 1.4.0
doi: 10.5281/zenodo.3526659
abstract: A dependency-free collection of simple functions for cleaning rectangular
data. This package allows to detect, count and replace values or discard rows/columns
Expand All @@ -32,12 +32,11 @@ preferred-citation:
year: '2023'
location:
name: Pessac, France
notes: R package version 1.3.0
notes: R package version 1.4.0
url: https://packages.tesselle.org/arkhe/
doi: 10.5281/zenodo.3526659
institution:
name: Université Bordeaux Montaigne
repository: https://CRAN.R-project.org/package=arkhe
repository-code: https://github.com/tesselle/arkhe
url: https://packages.tesselle.org/arkhe/
contact:
Expand All @@ -63,6 +62,17 @@ references:
institution:
name: R Foundation for Statistical Computing
version: '>= 3.5'
- type: software
title: graphics
abstract: 'R: A Language and Environment for Statistical Computing'
notes: Imports
authors:
- name: R Core Team
location:
name: Vienna, Austria
year: '2023'
institution:
name: R Foundation for Statistical Computing
- type: software
title: methods
abstract: 'R: A Language and Environment for Statistical Computing'
Expand Down
5 changes: 4 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: arkhe
Title: Tools for Cleaning Rectangular Data
Version: 1.3.0.9000
Version: 1.4.0
Authors@R: c(
person("Nicolas", "Frerebeau", , "nicolas.frerebeau@u-bordeaux-montaigne.fr", role = c("aut", "cre"),
comment = c(ORCID = "0000-0001-5759-4944", affiliation = "Université Bordeaux Montaigne")),
Expand All @@ -20,6 +20,7 @@ BugReports: https://github.com/tesselle/arkhe/issues
Depends:
R (>= 3.5)
Imports:
graphics,
methods,
stats,
utils
Expand All @@ -44,8 +45,10 @@ Collate:
'discard.R'
'keep.R'
'mathematics.R'
'plot.R'
'remove.R'
'replace.R'
'scale.R'
'statistics.R'
'utilities.R'
'zzz.R'
8 changes: 7 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# arkhe 1.3.0.9000
# arkhe 1.4.0
## New classes and methods
* Add `%||%` to replace `NULL` with a default value.
* Add `%+%` to concatenate character vectors.
* Add `scale_range` to rescale a continuous vector to have specified minimum and maximum.

## Bugfixes & changes
* Remove deprecated methods.
* Remove `na.rm` argument of numeric predicates (so that the length of the output equals the length of the input).

# arkhe 1.3.0
Expand Down
2 changes: 1 addition & 1 deletion R/arkhe-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#' \tabular{ll}{
#' **Package:** \tab arkhe \cr
#' **Type:** \tab Package \cr
#' **Version:** \tab 1.3.0 \cr
#' **Version:** \tab 1.4.0 \cr
#' **License:** \tab GPL-3 \cr
#' **Zenodo:** \tab \doi{10.5281/zenodo.3526659} \cr
#' }
Expand Down
1 change: 1 addition & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ knitr::opts_chunk$set(
fig.path = "man/figures/README-",
out.width = NULL
)
Sys.setlocale("LC_MESSAGES", 'en_GB.UTF-8') # Force locale
```

# arkhe <img width=120px src="man/figures/logo.png" align="right" />
Expand Down
51 changes: 25 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,17 @@ messages.
Frerebeau N (2023). _arkhe: Tools for Cleaning Rectangular Data_.
Université Bordeaux Montaigne, Pessac, France.
doi:10.5281/zenodo.3526659 <https://doi.org/10.5281/zenodo.3526659>,
R package version 1.3.0, <https://packages.tesselle.org/arkhe/>.
R package version 1.4.0, <https://packages.tesselle.org/arkhe/>.

Une entrée BibTeX pour les utilisateurs LaTeX est
A BibTeX entry for LaTeX users is

@Manual{,
author = {Nicolas Frerebeau},
title = {{arkhe: Tools for Cleaning Rectangular Data}},
year = {2023},
organization = {Université Bordeaux Montaigne},
address = {Pessac, France},
note = {R package version 1.3.0},
note = {R package version 1.4.0},
url = {https://packages.tesselle.org/arkhe/},
doi = {10.5281/zenodo.3526659},
}
Expand Down Expand Up @@ -93,50 +93,49 @@ k <- sample(1:25, 3, FALSE)
X[k] <- NA
X
#> [,1] [,2] [,3] [,4] [,5]
#> [1,] 5 8 NA 3 5
#> [2,] 9 7 8 4 2
#> [3,] 4 10 7 NA 2
#> [4,] NA 5 5 4 3
#> [5,] 7 9 9 8 1
#> [1,] 9 10 10 4 9
#> [2,] 1 6 6 10 4
#> [3,] NA 3 NA 3 5
#> [4,] 3 10 2 8 NA
#> [5,] 4 9 3 9 3

## Count missing values in rows
count(X, f = is.na, margin = 1)
#> [1] 1 0 1 1 0
#> [1] 0 0 2 1 0
## Count non-missing values in columns
count(X, f = is.na, margin = 2, negate = TRUE)
#> V1 V2 V3 V4 V5
#> 4 5 4 4 5
#> [1] 4 5 4 5 4

## Find row with NA
detect(X, f = is.na, margin = 1)
#> [1] TRUE FALSE TRUE TRUE FALSE
#> [1] FALSE FALSE TRUE TRUE FALSE
## Find column without any NA
detect(X, f = is.na, margin = 2, negate = TRUE, all = TRUE)
#> V1 V2 V3 V4 V5
#> FALSE TRUE FALSE FALSE TRUE
#> [1] FALSE TRUE FALSE TRUE FALSE

## Remove row with any NA
discard(X, f = is.na, margin = 1, all = FALSE)
#> [,1] [,2] [,3] [,4] [,5]
#> [1,] 9 7 8 4 2
#> [2,] 7 9 9 8 1
#> [1,] 9 10 10 4 9
#> [2,] 1 6 6 10 4
#> [3,] 4 9 3 9 3
## Remove column with any NA
discard(X, f = is.na, margin = 2, all = FALSE)
#> [,1] [,2]
#> [1,] 8 5
#> [2,] 7 2
#> [3,] 10 2
#> [4,] 5 3
#> [5,] 9 1
#> [1,] 10 4
#> [2,] 6 10
#> [3,] 3 3
#> [4,] 10 8
#> [5,] 9 9

## Replace NA with zeros
replace_NA(X, value = 0)
#> [,1] [,2] [,3] [,4] [,5]
#> [1,] 5 8 0 3 5
#> [2,] 9 7 8 4 2
#> [3,] 4 10 7 0 2
#> [4,] 0 5 5 4 3
#> [5,] 7 9 9 8 1
#> [1,] 9 10 10 4 9
#> [2,] 1 6 6 10 4
#> [3,] 0 3 0 3 5
#> [4,] 3 10 2 8 0
#> [5,] 4 9 3 9 3
```

## Contributing
Expand Down
30 changes: 11 additions & 19 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,13 @@
"codeRepository": "https://github.com/tesselle/arkhe",
"issueTracker": "https://github.com/tesselle/arkhe/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "1.3.0.9000",
"version": "1.4.0",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 4.3.1 (2023-06-16)",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"author": [
{
"@type": "Person",
Expand Down Expand Up @@ -52,14 +46,7 @@
{
"@type": "SoftwareApplication",
"identifier": "tinytest",
"name": "tinytest",
"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=tinytest"
"name": "tinytest"
}
],
"softwareRequirements": {
Expand All @@ -70,23 +57,28 @@
"version": ">= 3.5"
},
"2": {
"@type": "SoftwareApplication",
"identifier": "graphics",
"name": "graphics"
},
"3": {
"@type": "SoftwareApplication",
"identifier": "methods",
"name": "methods"
},
"3": {
"4": {
"@type": "SoftwareApplication",
"identifier": "stats",
"name": "stats"
},
"4": {
"5": {
"@type": "SoftwareApplication",
"identifier": "utils",
"name": "utils"
},
"SystemRequirements": null
},
"fileSize": "256.781KB",
"fileSize": "275.718KB",
"citation": [
{
"@type": "SoftwareSourceCode",
Expand All @@ -101,7 +93,7 @@
"name": "{arkhe: Tools for Cleaning Rectangular Data}",
"identifier": "10.5281/zenodo.3526659",
"url": "https://packages.tesselle.org/arkhe/",
"description": "R package version 1.3.0.9000",
"description": "R package version 1.4.0",
"@id": "https://doi.org/10.5281/zenodo.3526659",
"sameAs": "https://doi.org/10.5281/zenodo.3526659"
}
Expand Down
6 changes: 3 additions & 3 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## revdepcheck results

We checked 4 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
We checked 3 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.

* We saw 0 new problems
* We failed to check 0 packages
* We saw 0 new problems
* We failed to check 0 packages
2 changes: 1 addition & 1 deletion man/arkhe-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions revdep/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
|collate |fr_FR.UTF-8 |
|ctype |fr_FR.UTF-8 |
|tz |Europe/Paris |
|date |2023-08-31 |
|rstudio |2023.06.1+524 Mountain Hydrangea (desktop) |
|date |2023-10-27 |
|rstudio |2023.09.0+463 Desert Sunflower (desktop) |
|pandoc |3.1.1 @ /usr/lib/rstudio/resources/app/bin/quarto/bin/tools/ (via rmarkdown) |

# Dependencies

|package |old |new |Δ |
|:-------|:-----|:-----|:--|
|arkhe |1.2.0 |1.3.0 |* |
|arkhe |1.3.0 |1.4.0 |* |

# Revdeps

2 changes: 1 addition & 1 deletion revdep/cran.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## revdepcheck results

We checked 4 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
We checked 3 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.

* We saw 0 new problems
* We failed to check 0 packages
Expand Down

0 comments on commit aa35668

Please sign in to comment.