Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

protGear #2460

Closed Keniajin closed 2 years ago

Keniajin commented 2 years ago

Update the following URL to point to the GitHub repository of the package you wish to submit to Bioconductor

Confirm the following by editing each check box to '[x]'

I am familiar with the essential aspects of Bioconductor software management, including:

For questions/help about the submission process, including questions about the output of the automatic reports generated by the SPB (Single Package Builder), please use the #package-submission channel of our Community Slack. Follow the link on the home page of the Bioconductor website to sign up.

bioc-issue-bot commented 2 years ago

Hi @Keniajin

Thanks for submitting your package. We are taking a quick look at it and you will hear back from us soon.

The DESCRIPTION file for this package is:

Package: protGear
Type: Package
Title: Protein Micro Array Data Management and Interactive Visualization
Version: 0.99.1
Authors@R: c(person("Kennedy", "Mwai", role = c("cre", "aut"), email = "ken@keniajin.com|keniajn@gmail.com"),
   person(c("James", "Mburu"), role = "aut" , email = "mburuwanja@gmail.com") ,
   person(c("Jacqueline", "Waeni"), role = "ctb" , email = "jacqwaeni@gmail.com"))
Maintainer: The package maintainer <keniajin@gmail.com>
Description: A generic three-step pre-processing package for protein microarray data. This package contains different data pre-processing procedures to allow comparison of their performance.These steps are background correction, the coefficient of variation (CV) based filtering,  batch correction and normalization.
License: GPL-3
URL: https://github.com/Keniajin/protGear
BugReports: https://github.com/Keniajin/protGear/issues
Depends:
    R (>= 4.1), limma (>= 3.40.2) , magrittr (>= 1.5) , ggplot2 (>= 3.3.0), dplyr (>= 0.8.0) , tidyr (>= 1.1.3) , data.table (>= 1.14.0),
    ggpubr (>= 0.4.0), gtools (>= 3.8.2) ,gridExtra (>= 2.3), tibble (>= 3.1.0) , rlang (>= 0.4.10) , rmarkdown (>= 2.9) , knitr (>= 1.33),
    vsn (>= 3.54.0) , stats (>= 3.6), utils (>= 3.6), genefilter (>= 1.74.0), readr (>= 2.0.1) , Biobase (>= 2.52.0),
    MASS (>= 7.3) , styler (>= 1.6.1)
Imports:
    shiny (>= 1.0.0) , trend (>= 1.1.4),  purrr (>= 0.3.4), pacman (>= 0.5.0), plotly (>= 4.9.0) , 
    htmltools (>= 0.4.0) , flexdashboard (>= 0.5.2) , shinydashboard (>= 0.7.1)
biocViews: Microarray, OneChannel, Preprocessing , BiomedicalInformatics , Proteomics , BatchEffect, Normalization
Encoding: UTF-8
LazyData: false
RoxygenNote: 7.1.2
VignetteBuilder: knitr
vjcitn commented 2 years ago

Thanks for this submission. This is a very interesting package and I hope we can review it favorably. At present, we cannot review it for a few reasons. First, my own attempt to install the package failed because of pacman misbehavior. Please do not use pacman functions in your package. Package installation activities are to be governed by the DESCRIPTION file as it will be processed by BiocManager::install(). All dependencies and imported packages that are in CRAN or Bioconductor will be resolved by the build system to ensure your vignettes and examples can be tested. Second there are references in the vignette to a file that does not exist. I dug around and found it under inst/extdata, and you need to change

header_gpr <- readLines("data/array_data/machine1/KK2-06.txt",
                        n=40)

to

header_gpr <- readLines(system.file("extdata/array_data/machine1/KK2-06.txt", package="protGear"),
                        n=40)

.. a number of other file references need to be changed in the same way. Please add more comments to this issue if you have additional questions. Once these changes are made I will reevaluate for review.

Keniajin commented 2 years ago

Hi @vjcitn, thanks. I have updated and removed the pacman functions in my package. The updates on the files have also been done. I am getting an error after running Biocheck::Biocheck()of "Maintainer must register at the support site; visit https://support.bioconductor.org/accounts/signup/ .". Could have an idea why this is happening.

lshep commented 2 years ago

Did you register the email: keniajn@gmail.com at the support site as requested? It is not showing as a valid registered support site email address to any user on the support site

Keniajin commented 2 years ago

Thanks @lshep , I was missing an i in the email.

vjcitn commented 2 years ago

In your vignette you have

```{r setup, include=FALSE}
ploads <- c('tidyverse','ggpubr','gtools','purrr','scales','pheatmap', 'data.table','kableExtra','gridExtra', 'png','knitr' ,'grid','styler',  'factoextra','FactoMineR','magick','rlang','GGally','ggplotify', 'remotes')
sapply(ploads, require, character.only = TRUE)

Please do not do this. Use library() in the vignette when needed. You can use library() within suppressPackageStartupMessages in a hidden chunk to get packages loaded early on. Also your vignette wants tidyverse but it is not mentioned in DESCRIPTION.

vjcitn commented 2 years ago

Does your package pass R CMD check locally? I can't even build on linux:

 --- function search by body ---
Function .onLoad in namespace kableExtra has this body.
 ----------- END OF FAILURE REPORT -------------- 
Quitting from lines 88-89 (vignette.Rmd) 
Error: processing vignette 'vignette.Rmd' failed with diagnostics:
package or namespace load failed for 'protGear':
 .onLoad failed in loadNamespace() for 'kableExtra', details:
  call: !is.null(rmarkdown::metadata$output) && rmarkdown::metadata$output %in% 
  error: 'length(x) = 2 > 1' in coercion to 'logical(1)'
--- failed re-building ‘vignette.Rmd’
Keniajin commented 2 years ago

The package builds well on R CMD

During startup - Warning messages:
1: Setting LC_COLLATE=en_GB.UTF-8 failed
2: Setting LC_CTYPE=en_GB.UTF-8 failed
3: Setting LC_MONETARY=en_GB.UTF-8 failed
4: Setting LC_TIME=en_GB.UTF-8 failed
* checking for file 'protGear/DESCRIPTION' ... OK
* preparing 'protGear':
* checking DESCRIPTION meta-information ... OK
* installing the package to build vignettes
* creating vignettes ... OK
* checking for LF line-endings in source and make files and shell scripts
* checking for empty or unneeded directories
Removed empty directory 'protGear/data/raw_BG'
Removed empty directory 'protGear/data/raw_MFI_BG'
Removed empty directory 'protGear/data/sample_folder'
Removed empty directory 'protGear/data'
Removed empty directory 'protGear/inst/shiny-examples/protGear_interactive/load_data_dashboard/processed_data'
Removed empty directory 'protGear/vignettes/data/array_sampleID'
Omitted 'LazyData' from DESCRIPTION
* building 'protGear_0.99.1.tar.gz'
vjcitn commented 2 years ago

Please provide the sessionInfo() after doing rcmdcheck::rcmdcheck() on your tarball along with the output of the rcmdcheck. Thanks!

vjcitn commented 2 years ago

Also please make the changes necessary to avoid

Removed empty directory 'protGear/data/raw_BG'
Removed empty directory 'protGear/data/raw_MFI_BG'
Removed empty directory 'protGear/data/sample_folder'
Removed empty directory 'protGear/data'
Removed empty directory 'protGear/inst/shiny-examples/protGear_interactive/load_data_dashboard/processed_data'
Removed empty directory 'protGear/vignettes/data/array_sampleID'
vjcitn commented 2 years ago

I hope you will be finding some time to address some of the concerns in the review. A new submission needs to be tested in the devel branch of R (version 4.2). You might want to take advantage of the mentoring program, see https://docs.google.com/forms/d/e/1FAIpQLSf_xEOQU6Ye78qF0o0tcUhmMHWui-QVX8R-53KQE8c13qQMqA/viewform ... I hope you have a pleasant new year and that we will hear back from you soon.

Keniajin commented 2 years ago

Please provide the sessionInfo() after doing rcmdcheck::rcmdcheck() on your tarball along with the output of the rcmdcheck. Thanks!

Here is the sessionInfo()

> sessionInfo()
R version 4.1.1 (2021-08-10)
Platform: x86_64-w64-mingw32/x64 (64-bit)
Running under: Windows 10 x64 (build 19042)

Matrix products: default

locale:
[1] LC_COLLATE=English_United Kingdom.1252  LC_CTYPE=English_United Kingdom.1252    LC_MONETARY=English_United Kingdom.1252
[4] LC_NUMERIC=C                            LC_TIME=English_United Kingdom.1252    

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods   base     

loaded via a namespace (and not attached):
 [1] processx_3.5.2    compiler_4.1.1    R6_2.5.1          rprojroot_2.0.2   cli_3.0.1         tools_4.1.1       prettyunits_1.1.1 withr_2.4.2      
 [9] crayon_1.4.1      xopen_1.0.0       rcmdcheck_1.3.3   desc_1.3.0        callr_3.7.0       digest_0.6.27     pkgbuild_1.2.0    ps_1.6.0  
Keniajin commented 2 years ago

I hope you will be finding some time to address some of the concerns in the review. A new submission needs to be tested in the devel branch of R (version 4.2). You might want to take advantage of the mentoring program, see https://docs.google.com/forms/d/e/1FAIpQLSf_xEOQU6Ye78qF0o0tcUhmMHWui-QVX8R-53KQE8c13qQMqA/viewform ... I hope you have a pleasant new year and that we will hear back from you soon.

Unfortunately I missed this since I was on break, is there another chance available?

vjcitn commented 2 years ago

Hi, I am surprised about the mentorship form closure. I will check with the head of that program. In any case, please install R 4.2 (devel branch) and test your package with that. That is obligatory for submissions in this part of the year.

vjcitn commented 2 years ago

Well, the mentorship program is indeed closed for the first cycle. Please install R 4.2, run your package through R CMD check and if there are no errors we will proceed with the review. But do comment here when you complete this check.

vjcitn commented 2 years ago

Please try to run R CMD check on a "clean" deployment of R, so that system peculiarities do not affect the check. There should be no references to local files except as mediated by system.file() to refer to relatively small files that are installed with the package.

Keniajin commented 2 years ago

I have testes using the R 4.2 (devel branch) and the package builds well

`0 errors ✔ | 1 warning ✖ | 7 notes ✖
> sessionInfo()
R Under development (unstable) (2022-01-05 r81453 ucrt)
Platform: x86_64-w64-mingw32/x64 (64-bit)
Running under: Windows 10 x64 (build 19042)

Matrix products: default

locale:
[1] LC_COLLATE=English_United Kingdom.utf8  LC_CTYPE=English_United Kingdom.utf8    LC_MONETARY=English_United Kingdom.utf8 LC_NUMERIC=C                           
[5] LC_TIME=English_United Kingdom.utf8    

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods   base     

other attached packages:
 [1] remotes_2.4.2        ggplotify_0.1.0      FactoMineR_2.4       factoextra_1.0.7     styler_1.6.2         png_0.1-7            pheatmap_1.0.12      GGally_2.1.2        
 [9] kableExtra_1.3.4     shinydashboard_0.7.2 flexdashboard_0.5.2  htmltools_0.5.2      plotly_4.10.0        purrr_0.3.4          trend_1.1.4          shiny_1.7.1         
[17] dplyr_1.0.7          plyr_1.8.6           readr_2.1.1          rmarkdown_2.11       rlang_0.4.12         tibble_3.1.6         gridExtra_2.3        gtools_3.9.2        
[25] ggpubr_0.4.0         data.table_1.14.2    tidyr_1.1.4          ggplot2_3.3.5        pacman_0.5.1        

loaded via a namespace (and not attached):
 [1] colorspace_2.0-2     ggsignif_0.6.3       ellipsis_0.3.2       rprojroot_2.0.2      rstudioapi_0.13      ggrepel_0.9.1        DT_0.20              fansi_0.5.0         
 [9] xml2_1.3.3           R.methodsS3_1.8.1    leaps_3.1            knitr_1.37           jsonlite_1.7.2       broom_0.7.11         cluster_2.1.2        R.oo_1.24.0         
[17] BiocManager_1.30.16  compiler_4.2.0       httr_1.4.2           backports_1.4.1      fastmap_1.1.0        lazyeval_0.2.2       cli_3.1.0            later_1.3.0         
[25] prettyunits_1.1.1    tools_4.2.0          gtable_0.3.0         glue_1.6.0           Rcpp_1.0.7           carData_3.0-5        xopen_1.0.0          vctrs_0.3.8         
[33] svglite_2.0.0        xfun_0.29            stringr_1.4.0        ps_1.6.0             rvest_1.0.2          mime_0.12            lifecycle_1.0.1      rstatix_0.7.0       
[41] MASS_7.3-54          scales_1.1.1         hms_1.1.1            promises_1.2.0.1     RColorBrewer_1.1-2   curl_4.3.2           rcmdcheck_1.4.0      yulab.utils_0.0.4   
[49] reshape_0.8.8        stringi_1.7.6        desc_1.4.0           pkgbuild_1.3.1       pkgconfig_2.0.3      systemfonts_1.0.3    evaluate_0.14        lattice_0.20-45     
[57] htmlwidgets_1.5.4    processx_3.5.2       tidyselect_1.1.1     magrittr_2.0.1       R6_2.5.1             generics_0.1.1       pillar_1.6.4         withr_2.4.3         
[65] scatterplot3d_0.3-41 abind_1.4-5          crayon_1.4.2         car_3.0-12           utf8_1.2.2           tzdb_0.2.0           grid_4.2.0           callr_3.7.0         
[73] digest_0.6.29        flashClust_1.01-2    webshot_0.5.2        xtable_1.8-4         R.cache_0.15.0       httpuv_1.6.5         extraDistr_1.9.1     gridGraphics_0.5-1  
[81] R.utils_2.11.0       munsell_0.5.0        viridisLite_0.4.0 `
vjcitn commented 2 years ago

Confirmed. Package will proceed to review next week.

bioc-issue-bot commented 2 years ago

A reviewer has been assigned to your package. Learn what to expect during the review process.

IMPORTANT: Please read this documentation for setting up remotes to push to git.bioconductor.org. It is required to push a version bump to git.bioconductor.org to trigger a new build.

Bioconductor utilized your github ssh-keys for git.bioconductor.org access. To manage keys and future access you may want to active your Bioconductor Git Credentials Account

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "ERROR, skipped". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Keniajin commented 2 years ago

I am trying to git fetch from upstream but I am getting access rights error

Fetching upstream
git@git.bioconductor.org: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
error: Could not fetch upstream
lshep commented 2 years ago

Please make sure you have activated and added ssh-keys to your GitCredentials account as mentioned above: https://git.bioconductor.org/BiocCredentials

Keniajin commented 2 years ago

access_credentials

access_credentials2 I have added the keys but seems not to be going through

lshep commented 2 years ago

Please show the full commands you are trying with output

Keniajin commented 2 years ago

Hi @lshep below are the commands. I have updated the repository on my Github to remove the errors.

$  git remote add upstream git@git.bioconductor.org:packages/protGear.git
$ git remote -v
origin  https://github.com/Keniajin/protGear.git (fetch)
origin  https://github.com/Keniajin/protGear.git (push)
upstream        git@git.bioconductor.org:packages/protGear.git (fetch)
upstream        git@git.bioconductor.org:packages/protGear.git (push)

$ git fetch --all
Fetching origin
Fetching upstream
git@git.bioconductor.org: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
error: Could not fetch upstream
lshep commented 2 years ago

Have you added ssh-keys? Please check out the FAQ page specifically 14-16

Keniajin commented 2 years ago

Thanks @lshep, I had to add a new public key to work. Just to ‘Bump’ the package version to build again?

vjcitn commented 2 years ago

Yes. Bump the version and commit and push.

bioc-issue-bot commented 2 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: fd64ad63a2999048ed3b60ce1ee35a0500bf6089

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "WARNINGS, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: bedcceaf777bde8712451288ba64605f0003d681

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "skipped, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 8fe88100aaa155cebfd1bbcbafef572971253b16

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "WARNINGS, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 5e485da18a9c0316cdfb6910d19bb9d7e36466c5

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "WARNINGS, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: b78bcc35a95640c7a3d2cf1a4fb0d887a436672d

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "WARNINGS, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 51e56c9518950f02a0041f37ec31f30ad1bd612d

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "WARNINGS, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: b95e04ccda212f98eeba2888d21d797c19c91980

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "skipped, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: 92b7003699c513d0772d45d2d28a3d675e11e8f2

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "WARNINGS, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Kayla-Morrell commented 2 years ago

Hello @Keniajin - In order for a formal review of the package to be done, all ERRORS and WARNINGS need to be addressed from the build report. Please clean up these issues and then I will begin my review.

Best, Kayla

bioc-issue-bot commented 2 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: a21d16d62380b2947a4c58ea2159194c82104362

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "WARNINGS, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

Received a valid push on git.bioconductor.org; starting a build for commit id: b1daadddb595d062d72c45bc86e230ab2cd9bc5a

bioc-issue-bot commented 2 years ago

Dear Package contributor,

This is the automated single package builder at bioconductor.org.

Your package has been built on Linux, Mac, and Windows.

On one or more platforms, the build results were: "WARNINGS, ERROR". This may mean there is a problem with the package that you need to fix. Or it may mean that there is a problem with the build system itself.

Please see the build report for more details. This link will be active for 21 days.

Remember: if you submitted your package after July 7th, 2020, when making changes to your repository push to git@git.bioconductor.org:packages/protGear to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Keniajin commented 2 years ago

Hello @Keniajin - In order for a formal review of the package to be done, all ERRORS and WARNINGS need to be addressed from the build report. Please clean up these issues and then I will begin my review.

Best, Kayla

Hi Kayla, I am addressing the package Source tarball size. I cannot pick why there is a difference in size from my local computer.