Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

phantasusLite #3174

Closed assaron closed 11 months ago

assaron commented 1 year 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 1 year ago

Hi @assaron

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: phantasusLite
Type: Package
Title: Loading and annotation RNA-Seq counts matrices 
Version: 0.99.0
Authors@R: c(person("Rita", "Sablina", role = "aut"),        
   person("Maxim", "Kleverov", role = "aut"),        
   person("Alexey", "Sergushichev", email = "alsergbox@gmail.com", role = c("aut", "cre")))
Description: PhantasusLite – a lightweight package with helper functions of general interest 
    extracted from phantasus package. In parituclar it simplifies working with public
    RNA-seq datasets from GEO by providing access to the remote
    HSDS repository with the precomputed gene counts from ARCHS4 and DEE2 projects.
Depends: R (>= 4.2)
Imports: 
    data.table, 
    rhdf5client(>= 1.21.5), 
    httr, stringr,
    stats, 
    utils, 
    Biobase, 
    rhdf5,
    methods
biocViews: GeneExpression, Transcriptomics, RNASeq
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.2.3
Suggests: 
    testthat (>= 3.0.0), 
    knitr, 
    rmarkdown, 
    GEOquery
VignetteBuilder: knitr
Config/testthat/edition: 3
bioc-issue-bot commented 12 months ago

Your package has been added to git.bioconductor.org to continue the pre-review process. A build report will be posted shortly. Please fix any ERROR and WARNING in the build report before a reviewer is assigned or provide a justification on why you feel the ERROR or WARNING should be granted an exception.

IMPORTANT: Please read this documentation for setting up remotes to push to git.bioconductor.org. All changes should be pushed to git.bioconductor.org moving forward. It is required to push a version bump to git.bioconductor.org to trigger a new build report.

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 12 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

On one or more platforms, the build results were: "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.

The following are build products from R CMD build on the Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): phantasusLite_0.99.0.tar.gz macOS 12.6.5 Monterey: phantasusLite_0.99.0.tar.gz

Links above 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/phantasusLite to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 12 months ago

A reviewer has been assigned to your package for an indepth review. Please respond accordingly to any further comments from the reviewer.

bioc-issue-bot commented 11 months ago

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

bioc-issue-bot commented 11 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details.

The following are build products from R CMD build on the Bioconductor Build System: Linux (Ubuntu 22.04.2 LTS): phantasusLite_0.99.1.tar.gz macOS 12.6.5 Monterey: phantasusLite_0.99.1.tar.gz

Links above 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/phantasusLite to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

Kayla-Morrell commented 11 months ago

@assaron - Thank you for submitting to Bioconductor. Please see the initial review of the package below. The required changes must be made while the suggested changes do not have to be (though we strongly encourage them). Comment back here with updates that have been made and when the package is ready for a re-review. Keep in mind that the deadline to accept new packages into the Bioconductor 3.18 release is 10/18. Any packages accepted after this date will be included in the next release.

General package development

DESCRIPTION

NAMESPACE

NEWS

Data

Vignette

Man pages

R code

Best, Kayla

bioc-issue-bot commented 11 months ago

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

bioc-issue-bot commented 11 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details.

The following are build products from R CMD build on the Bioconductor Build System: macOS 12.6.5 Monterey: phantasusLite_0.99.2.tar.gz Linux (Ubuntu 22.04.2 LTS): phantasusLite_0.99.2.tar.gz

Links above 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/phantasusLite to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

assaron commented 11 months ago

@Kayla-Morrell thank you for your comments, we've addressed all of the required ones and some of the suggested.

REQUIRED: The README files should include Bioconductor installation instructions. See Bioconductor package installation instructions on any current Bioconductor package landing page.

Now README recommends to install package from Bioconductor.

REQUIRED: Update R version dependency from 4.2 to 4.3.0.

Done.

SUGGESTION: Provide BugReports: field in DESCRIPTION with a relevant link to github for reporting issues.

Done.

SUGGESTION: Provide URL: field in DESCRIPTION.

Done.

REQUIRED: Exported functions should use camel case or underscoring and not include '.' which indicates S3 dispatch.

The functions were renamed to not contain '.'.

REQUIRED: inst/testdata/ is not an acceptable directory for data included in Bioconductor packages. We allow inst/extdata/ for raw data and data/ for readily availabe data. I would suggest putting this data in inst/extdata/ and documentation must be present in inst/scripts/. See our documentation here about package data and documentation.

We moved the files to inst/extdata/testdata (and removed unused files).

REQUIRED: Also, be sure that is data is being download from the web that is is completely necessary and be sure to utilize BiocFileCache were possible.

I believe we do not download any files in the standard meaning: we use HTTP API to access parts of the remote files. Thank you for your suggestion about BiocFileCache, I don't think it can be applied in a straightforward manner, but we will consider it for future versions. Hope that would be OK for now.

SUGGESTION: We strongly suggest using the BiocStyle package for formatting.

We're now using BiocStyle::html_document.

REQUIRED: There should be an 'Introduction' section that serves as an abstract to introduce the objective, models, unique functions, key points, etc. that distinguish the package from other packages in the same area.

We've added introduction section.

REQUIRED: There should be an 'Installation' section that demonstrates to users how to install the package from Bioconductor. These installation instructions should be included in an eval = FALSE code chunk.

We've added installation section

SUGGESTION: We strongly encourage the use of table of contents.

We've added table of contents

REQUIRED: The last section of the vignette should be 'Session Info' and include sessionInfo().

We've added session info section

REQUIRED: Use accessors, don't access S4 class slots via @ in vignette code.

We replaced using '@' with accessor function.

SUGGESTION: Non-exported functions do not need to be documented. I would suggest adding the tag @keywords internal if you would like the man page to be created but not be present in the function index.

Thank you, we didn't know about it. We've added internal keyword for all of the non-exported functions.

REQURIED: Avoid sapply(); use vapply() instead.

We've switched from sapply to vapply

REQUIRED: Avoid 1:..., use seq_len() or seq_along() instead.

We've removed usage of 1:...

REQUIRED: Avoid using = for assignment and use <- instead.

Fixed.

REQUIRED: Avoid the use of paste in condition signals.

We've removed use of paste in message calls.

REQUIRED: Avoid redundant stop and warn in signal conditions.

Fixed.

Kayla-Morrell commented 11 months ago

@assaron - Thank you for making the necessary changes. I have just one note that needs to be addressed before I can accept the package.

Data

Best, Kayla

bioc-issue-bot commented 11 months ago

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

bioc-issue-bot commented 11 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Build System.

Congratulations! The package built without errors or warnings on all platforms.

Please see the build report for more details.

The following are build products from R CMD build on the Bioconductor Build System: macOS 12.6.5 Monterey: phantasusLite_0.99.3.tar.gz Linux (Ubuntu 22.04.2 LTS): phantasusLite_0.99.3.tar.gz

Links above 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/phantasusLite to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

assaron commented 11 months ago

@Kayla-Morrell

REQUIRED: Thank you for moving the data into an inst/extdata/testdata/ directory. There needs to be documentation present for the files in this directory. The documentation belongs in inst/scripts/ and needs to very clearly state how the data was generated and source information. It should include source URLs and any key information regarding filtering or processing. It can be executable code, sudo code, or a text description.

We've added inst/script/testdata.md file with the text description of how the files were obtained.

bioc-issue-bot commented 11 months ago

Your package has been accepted. It will be added to the Bioconductor nightly builds.

Thank you for contributing to Bioconductor!

Reviewers for Bioconductor packages are volunteers from the Bioconductor community. If you are interested in becoming a Bioconductor package reviewer, please see Reviewers Expectations.

lshep commented 11 months ago

The default branch of your GitHub repository has been added to Bioconductor's git repository as branch devel.

To use the git.bioconductor.org repository, we need an 'ssh' key to associate with your github user name. If your GitHub account already has ssh public keys (https://github.com/assaron.keys is not empty), then no further steps are required. Otherwise, do the following:

  1. Add an SSH key to your github account
  2. Submit your SSH key to Bioconductor

See further instructions at

https://bioconductor.org/developers/how-to/git/

for working with this repository. See especially

https://bioconductor.org/developers/how-to/git/new-package-workflow/ https://bioconductor.org/developers/how-to/git/sync-existing-repositories/

to keep your GitHub and Bioconductor repositories in sync.

Your package will be included in the next nigthly 'devel' build (check-out from git at about 6 pm Eastern; build completion around 2pm Eastern the next day) at

https://bioconductor.org/checkResults/

(Builds sometimes fail, so ensure that the date stamps on the main landing page are consistent with the addition of your package). Once the package builds successfully, you package will be available for download in the 'Devel' version of Bioconductor using BiocManager::install("phantasusLite"). The package 'landing page' will be created at

https://bioconductor.org/packages/phantasusLite

If you have any questions, please contact the bioc-devel mailing list (https://stat.ethz.ch/mailman/listinfo/bioc-devel); this issue will not be monitored further.