Skip to content

update package size requirement #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LiNk-NY merged 5 commits into from
Nov 4, 2025
Merged

update package size requirement #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ac63a5f
update package size requirement
LiNk-NY Oct 31, 2025
8070612
change size requirement in vignette
LiNk-NY Oct 31, 2025
20c1aa7
update NEWS
LiNk-NY Nov 4, 2025
c3abb9a
use default package size in checkPackageSize call
LiNk-NY Nov 4, 2025
00d4e78
minor update spacing
LiNk-NY Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions NEWS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
CHANGES IN VERSION 1.48.0
-----------------------

BUG FIXES AND MINOR IMPROVEMENTS

o Package tarball size check updated to have a max of 10 MB (@LiNk-NY,
#234).

CHANGES IN VERSION 1.46.0
-----------------------

Expand Down
2 changes: 1 addition & 1 deletion R/BiocCheck.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ BiocCheckRun <-
if (is.null(dots[["no-check-pkg-size"]])){
handleCheck("Checking package size...")
if (.BiocPackage$isTar){
checkPackageSize(.BiocPackage, size=5)
checkPackageSize(.BiocPackage)
} else {
handleMessage("Skipped... only checked on source tarball", indent=4)
}
Expand Down
6 changes: 3 additions & 3 deletions R/checks.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ checkDeprecatedPackages <- function(.BiocPackage)
}
}

checkPackageSize <- function(.BiocPackage, size=5){
checkPackageSize <- function(.BiocPackage, size = 10) {
pkg <- .BiocPackage$sourceDir
pkgType <- .BiocPackage$packageType
if (is.na(pkgType) || pkgType == "Software") {
maxSize <- size*10^6 ## 5MB
maxSize <- size*10^6 ## in MB
pkgSize <- file.size(pkg)
if (pkgSize > maxSize){
if (pkgSize > maxSize) {
msgs <- c(
paste0("Package Size: ",
as.character(round(pkgSize/(10^6),2)), " MB"),
Expand Down
2 changes: 1 addition & 1 deletion vignettes/BiocCheck.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Can be disabled with `--no-check-pkg-size` and `--no-check-file-size`.

* **Checking package size**
Checks that the package size meets _Bioconductor_ requirements. The current
package size limit is 5 MB for Software packages. Experiment Data and
package size limit is 10 MB for Software packages. Experiment Data and
Annotation packages are excluded from this check. This check is only run if
checking a source tarball. (ERROR)

Expand Down
Loading