Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

atena #2213

Closed beacalvo closed 3 years ago

beacalvo commented 3 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 3 years ago

Hi @beacalvo

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: atena
Type: Package
Title: Analysis of Transposable Elements
Version: 0.99.36
Authors@R: c(
  person("Beatriz", "Calvo-Serra", email = "beatriz.calvo@upf.edu", role = c("aut","cre")),
  person("Robert", "Castelo", email = "robert.castelo@upf.edu", role = c("aut")))
Description: Quantify expression of transposable elements (TEs) from RNA-seq data through
    different methods, including ERVmap, TEtranscripts and Telescope. A common interface
    is provided to use each of these methods, which consists of building a parameter object,
    calling the quantification function with this object and getting a SummarizedExperiment
    object as output container of the quantified expression profiles. The implementation
    allows one to quantify TEs and gene transcripts in an integrated manner.
License: Artistic-2.0
Encoding: UTF-8
Depends:
    R (>= 4.1),
    SummarizedExperiment
Imports: 
    methods,
    stats,
    Matrix,
    BiocGenerics,
    BiocParallel,
    S4Vectors,
    IRanges,
    GenomicRanges,
    GenomicAlignments,
    Rsamtools,
    GenomeInfoDb,
    SQUAREM,
    sparseMatrixStats
Suggests:
    BiocStyle,
    knitr,
    rmarkdown,
biocViews: Transcription, Transcriptomics, RNASeq, Sequencing, Preprocessing, Software
VignetteBuilder: knitr
RoxygenNote: 7.1.1
bioc-issue-bot commented 3 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 3 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.

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

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

lshep commented 3 years ago

Please see the following review:

Build Report

DESCRIPTION

Unit tests

NEWS

README

inst

man

vignette

OK

R

Please address the following issues. When ready be sure to do a version bump to trigger a new build report and comment back here on how the above have been addressed or any clarification comments and request a re-review. Cheers,

bioc-issue-bot commented 3 years ago

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

bioc-issue-bot commented 3 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.

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

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

bioc-issue-bot commented 3 years ago

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

bioc-issue-bot commented 3 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.

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

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

bioc-issue-bot commented 3 years ago

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

beacalvo commented 3 years ago

Dear @lshep

Thank you very much for your review and useful suggestions. We have addressed your comments in the following way:

Build Report

  • [X] Please address coding practice NOTES.

We have solved most notes. Only one function has a length > 50 lines (70 lines) and the percentage of lines longer than 80 characters has been reduced to 2% (long messages/warnings/error), as well as the percentage of lines without an indent multiple of 4 (2%).

DESCRIPTION

  • [X] (Optional) A package URL and BugReports field is encouraged

An URL and BugReports field have been added to the DESCRIPTION file.

Unit tests

  • [ ] We highly suggest adding unit tests

We have included unit tests with a test coverage of 57%.

NEWS

  • [X] Please have (start date: August 1, 2021) removed or as a list element. The news file will not be properly formatted with this free form text piece.

We have removed the free form text.

README

  • [X] encouraged to now also include Bioconductor installation instructions

We have added instructions for the installation of the development version (once available) through BiocManager. We were unsure about whether to include the release version installation instructions, but we have finally also included these instructions.

inst

  • [X] Please also have an inst/script directory with information on how the data in inst/extdata was generated and minimally source/licenses information.

We have created the directory with the file “create-data_OhtaniSaito13.Rmd” with the code used to obtain the data files included in inst/extdata.

man

  • [X] (optional) we highly recommend a package help page for users that naively do ?atena that would point to main documentation or functions.

The help page has been created.

vignette

OK

R

  • [X] Seems like features setGeneric in AllClasses should be moved to AllGenerics

We agree, it has been changed.

  • [X] We would prefer message over cat for printing as users can optionally suppress. The exception obviously for the show method as cat is appropriate there.

Ok, it has been modified.

  • [X] Please remove any non used code such as ovIntersectionNonEmpty

We have removed all non used code.

  • [X] Seems like AllUtilies.R function could be moved to utils.R

We agree, we have moved the code in AllUtilies.R to utils.R and deleted the AllUtilies.R file.

  • [X] Functional programming: no code repetition. It seems like .buildOvValuesMatrix and .buildOvValuesMatrixTS are the same function? Only have one version of the functions and do not repeat code. All occurances like this should be cleaned up.

These two functions differed on just one line. The .buildOvValuesMatrix function has been modified so that it can now be used by all methods. This way, the .buildOvValuesMatrixTS function is not used anymore and has been deleted.

  • [X] In good practice you should close files opened with on.exit to ensure proper close out eg Telescope.R line 211-222.

We have added on.exit to close files.

  • [X] Is there a reason for the double function assignement In utils.R line 262

No, it was a mistake, thank you for pointing it out. We have fixed it.

Please address the following issues. When ready be sure to do a version bump to trigger a new build report and comment back here on how the above have been addressed or any clarification comments and request a re-review. Cheers,

Best regards, Bea

bioc-issue-bot commented 3 years 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.

rcastelo commented 3 years ago

Hi @lshep a week ago we received the notification above on the acceptance of the package, but so far it doesn't seem to part of the nightly builds yet. I guess this will happen at some point, but one question, can we push changes to git.bioconductor.org:packages/atena ? if yes, could i be added to have permissions to push changes as well?

thank you!! robert.

vjcitn commented 3 years ago

The master branch of your GitHub repository has been added to Bioconductor's git repository.

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/beacalvo.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("atena"). The package 'landing page' will be created at

https://bioconductor.org/packages/atena

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.