Skip to content
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.

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

scanMiR #2067

Closed
9 tasks done
fridoling opened this issue Apr 22, 2021 · 53 comments
Closed
9 tasks done

scanMiR #2067

fridoling opened this issue Apr 22, 2021 · 53 comments
Assignees
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution OK

Comments

@fridoling
Copy link

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 understand that by submitting my package to Bioconductor,
    the package source and all review commentary are visible to the
    general public.

  • I have read the Bioconductor Package Submission
    instructions. My package is consistent with the Bioconductor
    Package Guidelines.

  • I understand that a minimum requirement for package acceptance
    is to pass R CMD check and R CMD BiocCheck with no ERROR or WARNINGS.
    Passing these checks does not result in automatic acceptance. The
    package will then undergo a formal review and recommendations for
    acceptance regarding other Bioconductor standards will be addressed.

  • My package addresses statistical or bioinformatic issues related
    to the analysis and comprehension of high throughput genomic data.

  • I am committed to the long-term maintenance of my package. This
    includes monitoring the support site for issues that users may
    have, subscribing to the bioc-devel mailing list to stay aware
    of developments in the Bioconductor community, responding promptly
    to requests for updates from the Core team in response to changes in
    R or underlying software.

  • I am familiar with the Bioconductor code of conduct and
    agree to abide by it.

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

  • The 'devel' branch for new packages and features.
  • The stable 'release' branch, made available every six
    months, for bug fixes.
  • Bioconductor version control using Git
    (optionally via GitHub).

For help with submitting your package, please subscribe and post questions
to the bioc-devel mailing list.

@bioc-issue-bot
Copy link
Collaborator

Hi @fridoling

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: scanMiR
Type: Package
Title: scanMiR
Version: 0.99.11
Depends: R (>= 4.0)
Date: 2021-04-20
Authors@R: c(
    person("Pierre-Luc", "Germain", email="pierre-luc.germain@hest.ethz.ch", 
  role=c("cre","aut"), comment=c(ORCID="0000-0003-3418-4218")),
    person("Michael", "Soutschek", email="michael.soutschek@hest.ethz.ch", role="aut"),
    person("Fridolin", "Gross", email="fridolin.gross@hest.ethz.ch", role="aut"))
Imports:
    Biostrings,
    GenomicRanges,
    IRanges,
    data.table,
    BiocParallel,
    methods,
    GenomeInfoDb,
    S4Vectors,
    ggplot2,
    stats,
    stringi,
    utils,
    grid,
    gridExtra
Suggests: knitr, rmarkdown
Description:
    A set of tools for working with miRNA affinity models (KdModels),
    efficient scanning for miRNA binding sites, and predicting target 
    repression. It supports scanning using miRNA seeds, full miRNA sequences 
    (enabling 3' alignment) and KdModels, and includes the prediction of slicing
    and TDMD sites. Finally, it includes utility and plotting functions (e.g. 
    for the visual representation of miRNA-target alignemnt).
License: GPL-3
VignetteBuilder: knitr
RoxygenNote: 7.1.1
biocViews: miRNA, SequenceMatching

@bioc-issue-bot bioc-issue-bot added the 1. awaiting moderation submitted and waiting clearance to access resources label Apr 22, 2021
@fridoling fridoling changed the title https://github.com/ETHZ-INS/scanMiR scanMiR Apr 22, 2021
@bioc-issue-bot
Copy link
Collaborator

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 bioc-issue-bot added 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place and removed 1. awaiting moderation submitted and waiting clearance to access resources labels Apr 22, 2021
@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@plger
Copy link

plger commented Apr 27, 2021

Hi @hpages, honored to have you as reviewer ;)
We had initially planned to add a companion ExperimentData package to the submission via AdditionalPackage, namely https://github.com/ETHZ-INS/scanMiRData , however BiocCheck on scanMiRData gives a warning due to the size of some of the RData files (which are ~3, ~8 and ~12 Mb). Each object contains a KdModelList (a class defined by scanMiR) containing the affinity data of all miRNAs.
Can we submit this here as a traditional ExperimentData package, despite the warning? Or must it be transformed into an ExperimentHub package?
Thanks in advance for the help,
Pierre-Luc & Fridolin

@hpages
Copy link
Contributor

hpages commented Apr 28, 2021

Hi @plger ,

I would need to be able to take a look at those files in scanMiRData to provide some advice but unfortunately the link you provided doesn't work. Can you fix it?

Thanks,
H.

@plger
Copy link

plger commented Apr 28, 2021

sorry @hpages , I thought it was public already... now the link should work

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@hpages
Copy link
Contributor

hpages commented May 7, 2021

Hi @plger ,

scanMiRData_0.99.2.tar.gz is 23M which maybe is a little bit more than what we usually recommend for a data experiment package, so moving the datasets to ExperimentHub would make sense. However it's not crazy big either so we can work with that, at least for now. And since the 3 datasets are serialized instances of a new S4 class that is part of the submission (the KdModelList class), I actually think that it's going to be easier if the datasets live in the data package and not on ExperimentHub. Just in case the design of the S4 class changes during the review process (in which case updating the serialized datasets is going to be easier if they live in the package).

So yes, please submit scanMiRData as an additional package.

Thanks,
H.

@fridoling
Copy link
Author

AdditionalPackage: https://github.com/ETHZ-INS/scanMiRData

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@plger
Copy link

plger commented Jun 22, 2021

@hpages we've got a third (and last!) package ( https://github.com/ETHZ-INS/scanMiRApp ) depending on scanMiR. It's the dependency-heavy one, containing wrappers & extras & a shiny app... should we add it here again, or maybe wait for this review to be over and start a fresh new one after?

@lshep
Copy link
Contributor

lshep commented Jul 12, 2021

Sorry for the delay. If it is a related package that uses scanMiR or scanMirData than I would say it is okay to add it here as an AdditionalPackage. Cheers

@lshep lshep assigned vjcitn and unassigned hpages Jul 12, 2021
@vjcitn
Copy link
Collaborator

vjcitn commented Jul 12, 2021

This package is in good shape. I think it would be good to address BiocCheck events:

 [3] "Consider adding these automatically suggested biocViews: Alignment"                                                                                                                
 [4] " Avoid 1:...; use seq_len() or seq_along()"                                                                                                                                        
 ...                                                                                                                                     
 [6] "Consider adding a NEWS file, so your package news will be included in Bioconductor release announcements."                                                                         
 [7] "Consider adding unit tests. We strongly encourage them. See\n  http://bioconductor.org/developers/how-to/unitTesting-guidelines/."  

specifically the unit test suggestion is important; if you don't want to do it please indicate why.

@vjcitn
Copy link
Collaborator

vjcitn commented Jul 12, 2021

I also took the liberty of trying out the app. I used the example and was able to generate

Warning: Error in dots_list: argument "subtitle" is missing, with no default
  [No stack trace available]
Warning: The 'plotly_click' event tied a source ID of 'manhattan' is not registered. In order to obtain this event data, please add `event_register(p, 'plotly_click')` to the plot (`p`) that you wish to obtain event data from.
'select()' returned 1:1 mapping between keys and columns

Do you want to address these?

@plger
Copy link

plger commented Jul 14, 2021

@vjcitn the two scanMiRApp warnings are now fixed.
For this one I'll be the maintainer, is that going to create permission conflicts if we add it through this issue? (@fridoling being the scanMiR maintainer... he'll also be addressing your above scanMiR-related queries)
Thanks

@lshep
Copy link
Contributor

lshep commented Jul 14, 2021

Honestly, I dont know if a different maintainer on an additionalpackage would cause an issue; my suspicion is yes we would run into permission issue. The catch with opening a new issue is if these accompanied packages are not accepted yet and in the official Bioconductor repository then the new issue will not be able to find the dependent package so there may be a delay in reviewing the newly opened issue

@bioc-issue-bot
Copy link
Collaborator

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

@bioc-issue-bot
Copy link
Collaborator

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

@fridoling
Copy link
Author

@vjcitn we have added "Alignment" to the biocViews, a NEWS file, and unit tests (> 70% code coverage). We have used 1:... only if ranges are defined by hardcoded digits, so this cannot possibly cause any problems.

@fridoling
Copy link
Author

@lshep Thanks for the info. We are not in a hurry, so we can wait for the review of scanMiR to be finished and then open a new issue.

@vjcitn vjcitn added 3a. accepted will be ingested into Bioconductor daily builder for distribution and removed 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place labels Jul 20, 2021
@bioc-issue-bot
Copy link
Collaborator

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.

@vjcitn
Copy link
Collaborator

vjcitn commented Jul 21, 2021

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

https://bioconductor.org/packages/scanMiR

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.

@vjcitn vjcitn closed this as completed Jul 21, 2021
@vjcitn
Copy link
Collaborator

vjcitn commented Jul 21, 2021

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

https://bioconductor.org/packages/scanMiRData

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution OK
Projects
None yet
Development

No branches or pull requests

6 participants