Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

transmogR #3277

Closed smped closed 4 months ago

smped commented 5 months 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 5 months ago

Hi @smped

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: transmogR
Type: Package
Title: Modify a set of reference sequences using a set of variants
Version: 0.99.0
Authors@R: person("Stevie", "Pederson", 
    email = "stephen.pederson.au@gmail.com", 
    role = c("aut", "cre"),
    comment = c(ORCID = "0000-0001-8197-3303")
    )
Description: transmogR provides the tools needed to crate a new reference
    genome or reference transcriptome, using a set of variants. Variants can 
    be any combination of SNPs, Insertions and Deletions. The intended 
    use-case is to enable creation of variant-modified reference 
    transcriptomes for incorporation into transcriptomic pseudo-alignment 
    workflows, such as salmon.
License: GPL-3
Encoding: UTF-8
URL: https://github.com/smped/transmogR
BugReports: https://github.com/smped/transmogR/issues
Depends:
    Biostrings,
    GenomicRanges
Imports:
    BSgenome,
    ComplexUpset,
    GenomeInfoDb,
    GenomicFeatures,
    ggplot2,
    InteractionSet,
    IRanges,
    methods,
    parallel,
    rlang,
    scales,
    stats,
    S4Vectors,
    SummarizedExperiment,
    VariantAnnotation
Suggests:
    BiocStyle,
    BSgenome.Hsapiens.UCSC.hg38,
    extraChIPs,
    knitr,
    rmarkdown,
    rtracklayer,
    testthat (>= 3.0.0)
biocViews: Alignment, GenomicVariation, Sequencing, TranscriptomeVariant
BiocType: Software
VignetteBuilder: knitr
Roxygen: list(markdown = TRUE)  
RoxygenNote: 7.3.0
Config/testthat/edition: 3
lshep commented 5 months ago

you will likely be asked to make in inst/script that should have code, pseudocode, or text describing how the files in inst/extdata were creating including any relevant source or licensing information.

bioc-issue-bot commented 5 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 5 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Single Package Builder.

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 Single Package Builder: macOS 12.7.1 Monterey: transmogR_0.99.0.tar.gz Linux (Ubuntu 22.04.2 LTS): transmogR_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/transmogR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

smped commented 5 months ago

Hi @lshep ,

Thanks for the heads up. I have these documented in data-raw as markdown files. Should I move these files to inst/scripts?

bioc-issue-bot commented 5 months ago

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

LiNk-NY commented 5 months ago

Hi Stevie, @smped

Thank you for your submission. Please see the review below.

Best regards, Marcel


transmogR #3277

Overall, a solid package with good re-use of Bioconductor functionality (GRanges, etc.).

DESCRIPTION

NAMESPACE

vignettes

R

tests

> covr::package_coverage()
transmogR Coverage: 97.28%
R/genomogrify.R: 90.74%
R/parY.R: 94.12%
R/helpers.R: 94.83%
R/sjFromExons.R: 97.44%
R/transmogrify.R: 98.82%
R/indelcator.R: 100.00%
R/overlapsByVar.R: 100.00%
R/owl.R: 100.00%
R/upsetVarByCol.R: 100.00%
R/varTypes.R: 100.00%
smped commented 5 months ago

Thanks Marcel. Appreciate the suggestions & some great pickups there too. I'll update & push over the next few days

smped commented 5 months ago

Hi Marcel,

Changes made are:

Let me know if you spot anything else & I'll get onto it.

smped commented 4 months ago

Hi again @LiNk-NY ,

I can't push to Bioc. Is there a problem that needs to be rectified? Here's my git settings for the repo

$ git remote -v
origin  git@github.com:smped/transmogR.git (fetch)
origin  git@github.com:smped/transmogR.git (push)
upstream    git@git.bioconductor.org:packages/transmogR.git (fetch)
upstream    git@git.bioconductor.org:packages/transmogR.git (push)

I figured these out from Section 21.5.2 here

The output I see when I try is

$ git push upstream devel
FATAL: W any packages/transmogR steveped DENIED by fallthru
(or you mis-spelled the reponame)
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

I changed my git username to smped a year or two back because steveped was problematic, so could that be the issue?

lshep commented 4 months ago

We had to make a change in our configuration file. It should be updated and you should have access now. Sorry for the inconvenience.

bioc-issue-bot commented 4 months ago

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

smped commented 4 months ago

Thanks @lshep! Looks like that's done the trick.

bioc-issue-bot commented 4 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Single Package Builder.

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 Single Package Builder: Linux (Ubuntu 22.04.3 LTS): transmogR_0.99.2.tar.gz macOS 12.7.1 Monterey: transmogR_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/transmogR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

smped commented 4 months ago

Hi @lshep & @LiNk-NY

Going through the above report, it's pretty clear that merida1 is about 2-2.5 times slower at nearly every step. Where I see 12s on nebbiolo1, I can see 28s on merida1, and this applies for nearly every checking step with a timing provided. I read Vince's comment to the developers of MIRit and it seems this is a commonly emerging issue that you're actively trying to resolve, even though I'm seeing the issue on merida1 instead of kjohnson3 as discussed elsewhere.

If I optimise examples by setting don't run on OSX on a few I could probably cut 15-20s, but to me it seems like most of the timing blowout is coming from checks where I don't really have much control. Is either of you able to offer any helpful suggestions as I'm really not sure where else to start cutting my code down?

Thanks in advance

lshep commented 4 months ago

Yes merida1 is currently being maxed out at times which slows the process; if you are hitting the times on the linux nebbiolo1 machine I think we can ignore the warnings.

smped commented 4 months ago

Thanks @lshep . I also went & checked my latest gh-actions run and the Linux R CMD check took 4:32 whilst the OSX check took 5:42 and Windows took 4:51. So there's definitely an OSX platform slowdown beyond the BBS but it seems lees profound.

Do I need to make some edits & update the version to trigger a rebuild?

LiNk-NY commented 4 months ago

Hi Stevie, @smped Thank you for making those changes. Please remove the {} from setGeneric calls as they cause performance issues. For reference: https://adv-r.hadley.nz/s4.html?q=setGeneric#s4-generics Everything else looks good to go. Thanks, Marcel

bioc-issue-bot commented 4 months ago

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

bioc-issue-bot commented 4 months ago

Dear Package contributor,

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

Your package has been built on the Bioconductor Single Package Builder.

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 Single Package Builder: Linux (Ubuntu 22.04.3 LTS): transmogR_0.99.3.tar.gz macOS 12.7.1 Monterey: transmogR_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/transmogR to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

smped commented 4 months ago

Thanks for the tip Marcel @LiNk-NY ! Don't know how Id missed that, so that's a really good thing to know. Might sneak off to tidy up another package or two. :)

It looks like I'm still over 10min on merida1, but am much closer to the target. It looks like the big changes in timings were in the examples & tests, which tracks with the performance issues Hadley mentions. I could possibly move a couple of tests to longtests if you think that might help? That way I'd still keep the tests in good shape, but might just sneak under that 10min line-in-the-sand

LiNk-NY commented 4 months ago

Hi Stevie, @smped Thank you for making those changes. Your package has been accepted. Best regards, Marcel

bioc-issue-bot commented 4 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 4 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/smped.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("transmogR"). The package 'landing page' will be created at

https://bioconductor.org/packages/transmogR

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.