Skip to content

Commit a09e635

Browse files
authored
Submit CRAN 6.2.0 (#141)
* Increment version number to 6.2.0 * Update NEWS.md and cran-comments.md for 6.2.0 * Add safeguards to pass NoSuggests checks - added logic to skip adat2eSet() and pivotExpressionSet() examples and tests if Biobase is not installed in environment - added rlang to Suggests in DESCRIPTION for access to is_installed() function for checking if Biobase is installed
1 parent 8a818f8 commit a09e635

File tree

10 files changed

+158
-50
lines changed

10 files changed

+158
-50
lines changed

DESCRIPTION

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Type: Package
22
Package: SomaDataIO
33
Title: Input/Output 'SomaScan' Data
4-
Version: 6.1.0.9000
4+
Version: 6.2.0
55
Authors@R: c(
66
person(given = "Stu",
77
family = "Field",
@@ -41,6 +41,7 @@ Suggests:
4141
knitr,
4242
purrr,
4343
recipes,
44+
rlang,
4445
rmarkdown,
4546
spelling,
4647
testthat (>= 3.0.0),

NEWS.md

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,93 @@
1-
# SomaDataIO (development version)
1+
# SomaDataIO 6.2.0
2+
3+
### New Functions
4+
5+
* Added `calc_eLOD()` function (#131)
6+
- calculates the estimated limit of detection (eLOD)
7+
for SeqId columns of an input `soma_adat` or `data.frame`
8+
9+
### Bug Fixes
10+
11+
* Fixed `crayon` bug and `ui_bullet()` issue (#129, #130)
12+
- removed `crayon` and `usethis` as dependencies in favor of `cli`
13+
- fixed bug in R version 4.4.1 with `ui_bullet()` internal
14+
calls within `loadAdatsAsList()` and `write_adat()`
15+
16+
* Fixed bug in `Summary.soma_adat()` operations (#121)
17+
- these operations: `min()`, `max()`, `any()`, `range()`, etc.
18+
would return the incorrect value due to an `as.matrix()`
19+
conversion under the hood
20+
- now skips that conversion, trips a warning, and carries on
21+
- triggers an error if non-numerics are passed
22+
as part of the '...' outside of a `soma_adat`,
23+
just like `Summary.data.frame()`
24+
25+
### Function and Object Improvements
26+
27+
* `collapseAdats()` now maintains Cal.Set entries of Col.Meta (#113)
28+
- collapsing ADATs can be problematic for the attributes,
29+
especially for large numbers of ADATs
30+
- `collapseAdats()` now attempts to smartly
31+
merge the (potentially numerous elements) Col.Meta
32+
attribute in the final object, preserving
33+
the "Cal.Set" and "ColCheck" columns in particular
34+
- the resulting `Col.Meta` attribute is a combined product
35+
of the individual ADAT elements, and the _intersect_ of the
36+
analyte features (as is the case for the `rbind()` that is called)
37+
38+
* Updated checksums and versions for Annotations Excel files (#116)
39+
- updated the 7k and 11k file versions and md5sum checksums
40+
- now allows `read_annotations()` to load
41+
the individual Excel files
42+
43+
* Updated `lift_master` object to alpha sort columns
44+
45+
### Documentation Updates
46+
47+
* Updated company name, license year, and maintainer (#137)
48+
- SomaLogic Operating Co., Inc is now Standard BioTools, Inc.
49+
- updated license and copyright year to 2025
50+
- updated package maintainer to Caleb Scheidel
51+
52+
* Updated article links in README, intro vignette (#123)
53+
- updated links to articles in README and introduction
54+
vignette to URLs to pkgdown website rather than
55+
`vignette()` code references
56+
- added clarification to above documents that articles are
57+
available on website only rather than traditional vignettes
58+
included with package
59+
60+
* Updates to example documentation
61+
- `read_annotations()` example documentation now points to the
62+
most recent 11k Excel annotations file
63+
- `parseHeader()` example now prints list elements separately,
64+
rather than full object, which slowed website rendering
65+
66+
### Internal :construction:
67+
68+
* Updates to GitHub Action workflows
69+
- added `rhub.yaml` configuration file to comply with `rhub` v2
70+
- updated macOS version in `pkgdown.yaml` to macOS-14
71+
- added write permission to `pkgdown.yaml` file to enable deployment
72+
- changed GitHub Action R checks to MacOS and Windows only
73+
- `ubuntu` machine was taking too long to build
74+
75+
* Increased package test coverage
76+
- added unit tests for `getSomaScanLiftCCC()`,
77+
`parseCheck()` and release utilities which
78+
were previously untested
79+
- increased test coverage for `pivotExpressionSet()`
80+
81+
* Added missing package anchors to .Rd files (#139)
82+
- fixed note from remote windows check
83+
related to Rd \link{} targets missing
84+
package anchors
85+
86+
* Updated README badge (#109)
87+
- now shows 'downloads' per month over total downloads
88+
89+
* Fixed link in DESCRIPTION; master -> main (#107)
90+
291

392
# SomaDataIO 6.1.0 :partying_face: :champagne:
493

R/adat2eSet.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#' @return A Bioconductor object of class `ExpressionSet`.
2121
#' @author Stu Field
2222
#' @references \url{https://bioconductor.org/install/}
23-
#' @examples
23+
#' @examplesIf rlang::is_installed("Biobase")
2424
#' eSet <- adat2eSet(example_data)
2525
#' class(eSet)
2626
#' eSet

R/pivotExpressionSet.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
#' @return A `tibble` consisting of the long format
1010
#' conversion of an `ExpressionSet` object.
1111
#' @author Stu Field
12-
#' @examples
12+
#' @examplesIf rlang::is_installed("Biobase")
1313
#' # subset into a reduced mini-ADAT object
1414
#' # 10 samples (rows)
1515
#' # 5 clinical variables and 3 features (cols)

cran-comments.md

Lines changed: 45 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11

2-
# Submission 6.1.0
2+
# Submission 6.2.0
33

44
- This is a submission to an existing CRAN package.
55

66
- It contains feature upgrades, minor internal bug-fixes,
7-
much improved documentation, and expanded vignettes.
7+
and improved documentation.
88

99

1010
## Reverse Dependencies
@@ -18,28 +18,30 @@
1818

1919
## R CMD check results
2020
```
21-
0 errors | 0 warnings | 3 notes
21+
0 errors | 0 warnings | 2 notes
2222
```
2323

2424
### Notes
2525

26-
The following 3 `notes` were displayed during `rhub::check_for_cran()`:
26+
The following `notes` were displayed during
27+
`devtools::check(remote = TRUE, manual = TRUE)`:
2728

2829
```
29-
* checking HTML version of manual ... NOTE
30-
Skipping checking math rendering: package 'V8' unavailable
31-
32-
* checking for non-standard things in the check directory ... NOTE
33-
Found the following files/directories:
34-
''NULL''
35-
36-
* checking for detritus in the temp directory ... NOTE
37-
Found the following files/directories:
38-
'lastMiKTeXException'
30+
❯ checking CRAN incoming feasibility ... [7s/72s] NOTE
31+
Maintainer: ‘Caleb Scheidel <[email protected]>’
32+
33+
New maintainer:
34+
Caleb Scheidel <[email protected]>
35+
Old maintainer(s):
36+
Stu Field <[email protected]>
37+
38+
❯ checking installed package size ... NOTE
39+
installed size is 6.0Mb
40+
sub-directories of 1Mb or more:
41+
data 3.8Mb
42+
extdata 1.1Mb
3943
```
4044

41-
We do not believe these are issues under our control.
42-
4345

4446
## Package Size
4547

@@ -49,31 +51,32 @@ We do not believe these are issues under our control.
4951
## Example Timings from Win-builder
5052

5153
```
52-
name user system elapsed
53-
Col.Meta 0.28 0.02 0.29
54-
SeqId 0.05 0.00 0.04
55-
SomaDataIO-package 0.09 0.00 0.09
56-
SomaScanObjects 0.25 0.02 0.26
57-
adat-helpers 0.05 0.00 0.05
58-
adat2eSet 0.31 0.04 0.36
59-
addClass 0 0 0
60-
cleanNames 0 0 0
61-
diffAdats 0.18 0.11 0.30
62-
getAnalyteInfo 0.12 0.00 0.13
63-
getAnalytes 0.02 0.00 0.01
64-
groupGenerics 0.23 0.03 0.27
65-
is_intact_attr 0.02 0.00 0.01
66-
is_seqFormat 0.02 0.00 0.02
67-
lift_adat 0.26 0.00 0.27
68-
loadAdatsAsList 1.27 0.02 1.28
69-
merge_clin 0.08 0.00 0.08
70-
parseHeader 0.46 0.19 0.65
71-
pivotExpressionSet 0.06 0.00 0.06
72-
read_adat 1.22 0.01 1.23
73-
read_annotations 0 0 0
74-
rownames 0.01 0.00 0.02
75-
soma_adat 0.19 0.00 0.18
76-
transform 0 0 0
77-
write_adat 0.22 0.03 0.25
54+
name user system elapsed
55+
Col.Meta 0.23 0.01 0.25
56+
SeqId 0.03 0.02 0.05
57+
SomaDataIO-package 0.08 0.02 0.10
58+
SomaScanObjects 0.25 0.00 0.25
59+
adat-helpers 0.05 0.00 0.04
60+
adat2eSet 0.31 0.04 0.36
61+
addClass 0 0 0
62+
calc_eLOD 0.01 0.00 0.01
63+
cleanNames 0 0 0
64+
diffAdats 0.33 0.00 0.33
65+
getAnalyteInfo 0.11 0.00 0.11
66+
getAnalytes 0.02 0.00 0.01
67+
groupGenerics 0.28 0.00 0.28
68+
is_intact_attr 0 0 0
69+
is_seqFormat 0 0 0
70+
lift_adat 0.25 0.02 0.26
71+
loadAdatsAsList 1.36 0.00 1.36
72+
merge_clin 0.08 0.00 0.08
73+
parseHeader 0.08 0.01 0.09
74+
pivotExpressionSet 0.07 0.00 0.06
75+
read_adat 1.22 0.00 1.22
76+
read_annotations 0 0 0
77+
rownames 0 0 0
78+
soma_adat 0.2 0.0 0.2
79+
transform 0 0 0
80+
write_adat 0.24 0.01 0.25
7881
```
7982

inst/WORDLIST

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ aliquot
8787
analyte
8888
analytes
8989
barcode
90+
checksums
9091
cli
9192
dplyr
9293
eLOD
@@ -98,6 +99,7 @@ leftrightarrow
9899
lifecycle
99100
lysate
100101
magrittr
102+
md
101103
medNormRef
102104
nd
103105
normals

man/adat2eSet.Rd

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/pivotExpressionSet.Rd

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/testthat/test-adat2eSet.R

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11

2-
suppressPackageStartupMessages(library(Biobase))
2+
if ( rlang::is_installed("Biobase") ) {
3+
suppressPackageStartupMessages(library(Biobase))
4+
sub_adat <- example_data[1:10L, c(1:5L, 35:37L)]
5+
}
6+
37

4-
sub_adat <- example_data[1:10L, c(1:5L, 35:37L)]
58

69
test_that("`adat2eSet()` converts `soma_adt` -> eSet correctly", {
10+
testthat::skip_if_not_installed("Biobase")
711
eSet <- adat2eSet(sub_adat)
812
expect_s4_class(eSet, "ExpressionSet")
913
expect_true(is.matrix(eSet@assayData$exprs))
Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11

22
# Setup -----
3-
sub_adat <- example_data[1:10, c(1:5, 35:37)]
4-
long <- pivotExpressionSet(adat2eSet(sub_adat))
3+
if ( rlang::is_installed("Biobase") ) {
4+
sub_adat <- example_data[1:10, c(1:5, 35:37)]
5+
long <- pivotExpressionSet(adat2eSet(sub_adat))
6+
}
57

68
# Testing ----
79
test_that("pivotExpressionSet() returns the correct class and dimensions", {
10+
testthat::skip_if_not_installed("Biobase")
811
expect_s3_class(long, "tbl_df")
912
expect_equal(dim(long), c(30, 29))
1013
})
1114

1215
test_that("pivotExpressionSet() returns expected metadata columns", {
16+
testthat::skip_if_not_installed("Biobase")
1317
expect_setequal(rownames(sub_adat), long$array_id)
1418
expect_setequal(getAnalytes(sub_adat), long$feature)
1519
expect_true(all(names(attributes(sub_adat)$Col.Meta) %in% names(long)))
1620
expect_true(all(getMeta(sub_adat) %in% names(long)))
1721
})
1822

1923
test_that("pivotExpressionSet() preserves analyte values", {
24+
testthat::skip_if_not_installed("Biobase")
2025
expect_equal(sub_adat[order(row.names(sub_adat)),]$seq.10000.28,
2126
subset(long, feature == "seq.10000.28")$value)
2227
})

0 commit comments

Comments
 (0)