Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

dreamlet submission #2955

Closed GabrielHoffman closed 1 year ago

GabrielHoffman 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.

GabrielHoffman commented 1 year ago

@jianhong, Can you advise about the current warnings? I cannot resolve the warnings that say: unknown macro '\insertAllCited'

Following the directions in section 1 here doesn't work. This seems like it should come up often enough in Bioconductor

Gabriel

jianhong commented 1 year ago

@GabrielHoffman I agree with you that this should be not shown as a warning. And the documents section 4.2 explained about that. @lshep Could you please take a look?

lshep commented 1 year ago

I'm not sure we have encountered this way of doing citations yet. @LiNk-NY could this be a bug in BiocCheck? I think @jianhong it okay to ignore these warnings for now.

LiNk-NY commented 1 year ago

Hi @GabrielHoffman @jianhong and @lshep It is safe to ignore these warnings as noted in section 4.2 of the Rdpack documentation linked above. I will take a look at including the new macro location when tools::parse_Rd is called within BiocCheck.

Update: The warnings have been addressed in BiocCheck version 1.37.9.

Best, Marcel

jianhong commented 1 year ago

Package 'dreamlet' Review

Thank you for submitting your package to Bioconductor. The package passed check and build. It is almost there. However there are several things need to be fixed. Please try to answer the comments line by line when you are ready for a second review. Code: Note: please consider; Important: must be addressed.

General package development

* Important: WARNING: Empty or missing \value sections found in man
  pages.

Found in files: man/cellSpecificityValues-class.Rd, man/dreamlet_mash_result-class.Rd, man/dreamletProcessedData-class.Rd, man/dreamletResult-class.Rd, man/vpDF-class.Rd Please add @return in the R code to avoid the warning.

R code

jianhong commented 1 year ago

Could I expect the error fix soon? If not, I will close this issues.

jianhong commented 1 year ago

Hi @GabrielHoffman,

Because I did not see any progress here. I closed this issue now. You are welcome to reopen the issue once you are ready to resubmit.

Jianhong.

GabrielHoffman commented 1 year ago

Can you reopen this issue, I just submitted an update

bioc-issue-bot commented 1 year ago

Dear @GabrielHoffman ,

We have reopened the issue to continue the review process. Please remember to push a version bump to git.bioconductor.org to trigger a new build.

vjcitn commented 1 year ago

BTW I just noticed all the "=" to "<-" comments above. I was pleased to learn that the styler package can perform the replacements.

jianhong commented 1 year ago

@vjcitn Thanks for sharing. Next time I will just mention the solution instead of list all the positions.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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, 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.

The following are build products from R CMD build on the Bioconductor Build System: ERROR before build products produced.

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

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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: "WARNINGS". 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: macOS 12.6.5 Monterey: dreamlet_0.99.24.tar.gz Linux (Ubuntu 22.04.2 LTS): dreamlet_0.99.24.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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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: "WARNINGS". 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: macOS 12.6.5 Monterey: dreamlet_0.99.25.tar.gz Linux (Ubuntu 22.04.2 LTS): dreamlet_0.99.25.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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

GabrielHoffman commented 1 year ago

I fixed all the issues I could. Can you check?

Note, I could not add sessionInfo() to vignettes/mashr.Rmd since this vignette is pre-processed in my machine since it takes too link to run on the BioC machines

Gabriel

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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: "WARNINGS". 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): dreamlet_0.99.26.tar.gz macOS 12.6.5 Monterey: dreamlet_0.99.26.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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

GabrielHoffman commented 1 year ago

My package passes most checks except for:

* Checking man page documentation...
    * WARNING: Empty or missing \value sections found in man pages.

but it doesn't tell me which function this is in. And I don't get this warning locally.

How can I resolve this?

lshep commented 1 year ago

If you run BiocCheck locally there will be a directory dreamlet.BiocCheck that will have a file that has a more detailed 00BiocCheck.log that give the exact file name/line numbers

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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: dreamlet_0.99.27.tar.gz Linux (Ubuntu 22.04.2 LTS): dreamlet_0.99.27.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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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: dreamlet_0.99.28.tar.gz Linux (Ubuntu 22.04.2 LTS): dreamlet_0.99.28.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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

GabrielHoffman commented 1 year ago

Can you push this package to the next stage of Bioconductor approval?

Best, Gabriel

jianhong commented 1 year ago

Package 'dreamlet' Review

Thank you for your patience during the review process. The package is intricate, and I truly appreciate the substantial effort you've invested in it. Please try to answer the comments line by line when you are ready for a second review. Code: Note: please consider; Important: must be addressed.

General package development

R code

Unit test

bioc-issue-bot commented 1 year ago

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

bioc-issue-bot commented 1 year 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): dreamlet_0.99.29.tar.gz macOS 12.6.5 Monterey: dreamlet_0.99.29.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/dreamlet to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

GabrielHoffman commented 1 year ago

@jianhong I have addressed all the important issues. Confirm?

Gabriel

GabrielHoffman commented 1 year ago

@jianhong Following up to finalize this submission

Best, Gabriel

bioc-issue-bot commented 1 year 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 1 year 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/GabrielHoffman.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("dreamlet"). The package 'landing page' will be created at

https://bioconductor.org/packages/dreamlet

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.