Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
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

TMSig #3526

Closed
10 tasks done
TylerSagendorf opened this issue Aug 24, 2024 · 19 comments
Closed
10 tasks done

TMSig #3526

TylerSagendorf opened this issue Aug 24, 2024 · 19 comments
Assignees
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution OK

Comments

@TylerSagendorf
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 Bioconductor Package Naming Policy and acknowledge
    Bioconductor may retain use of package name.

  • 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 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
Copy link
Collaborator

Hi @TylerSagendorf

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: TMSig
Type: Package
Title: Tools for Molecular Signatures
Version: 0.99.0
Date: 2024-08-23
Authors@R: 
    c(
      person(given = "Tyler", family = "Sagendorf", 
   email = "tyler.sagendorf@pnnl.gov",
   comment = c(ORCID = "0000-0003-1552-4870"),
   role = c("aut", "cre")),
      person(given = "Di", family = "Wu", role = "ctb"),
      person(given = "Gordon", family = "Smyth", role = "ctb")
    )
Description: The TMSig package contains tools to prepare, analyze, and visualize
    named lists of sets, with an emphasis on molecular signatures (such as gene
    or kinase sets). It includes fast, memory efficient functions to construct
    sparse incidence and similarity matrices and filter, cluster, invert, and 
    decompose sets. Additionally, bubble heatmaps can be created to visualize 
    the results of any differential or molecular signatures analysis.
License: GPL (>= 3)
URL: https://github.com/EMSL-Computing/TMSig
BugReports: https://github.com/EMSL-Computing/TMSig/issues
Encoding: UTF-8
RoxygenNote: 7.3.2
Roxygen: list(markdown = TRUE)
VignetteBuilder: knitr
biocViews: Clustering, GeneSetEnrichment, GraphAndNetwork, Pathways, Visualization
Depends:
    R (>= 4.4.0),
    limma
Imports:
    circlize,
    ComplexHeatmap,
    data.table,
    grDevices,
    grid,
    lifecycle,
    Matrix,
    stats,
    utils
Suggests: 
    BiocStyle,
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
Config/testthat/edition: 3

@bioc-issue-bot bioc-issue-bot added the 1. awaiting moderation submitted and waiting clearance to access resources label Aug 24, 2024
@lshep
Copy link
Contributor

lshep commented Sep 4, 2024

Please include an inst/script/ directory that has a file that can be code,
psuedo code, or text but that describes how the data in inst/extdata was
generated. minimally containing source/licensing information. A user should be
able to get an idea of how to recreate the data if necessary.

Given this package seems to be working with geneSets. It will be necessary to
also include functionality to the common Bioconductor classes for gene sets by
also making functions compatible with BiocSet::BiocSet or the GSEABase::GeneSet
or likely more appropriate GSEABase::GetSetCollection. See
https://contributions.bioconductor.org/important-bioconductor-package-development-features.html#commonclass

@lshep lshep added 3e. pending pre-review changes review has indicated blocking concern that needs attention 3d. needs interop Package must explicitly use Bioconductor structures and methods labels Sep 4, 2024
@TylerSagendorf
Copy link
Author

@lshep I will get this taken care of. Since this doesn't have the pre-review tag, should I make these changes to the existing TMSig repo under EMSL-Computing?

@TylerSagendorf
Copy link
Author

Functions sparseIncidence, filterSets, and invertSets have been converted to S4 generics to support objects of class GeneSet and GeneSetCollection from GSEABase. I have also added a .txt file to inst/script/ that explains how c5.go.v2023.2.Hs.symbols.gmt.gz was generated.

@lshep
Copy link
Contributor

lshep commented Sep 9, 2024

thank you. we will take a re-evaluation soon.

@lshep lshep added pre-check passed pre-review performed and ready to be added to git and removed 3e. pending pre-review changes review has indicated blocking concern that needs attention 3d. needs interop Package must explicitly use Bioconductor structures and methods labels Sep 16, 2024
@bioc-issue-bot
Copy link
Collaborator

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 bioc-issue-bot added pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean and removed 1. awaiting moderation submitted and waiting clearance to access resources pre-check passed pre-review performed and ready to be added to git labels Sep 17, 2024
@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 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:
Linux (Ubuntu 22.04.3 LTS): TMSig_0.99.0.tar.gz
Linux (Ubuntu 24.04.1 LTS): TMSig_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/TMSig 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: f35e1feab4612ac8a48cb0365beca90cc0dc0a10

@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 the Bioconductor Single Package Builder.

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): TMSig_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/TMSig to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot bioc-issue-bot added OK and removed ERROR labels Sep 30, 2024
@lshep lshep added 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place and removed pre-review on bioconductor git and access to on demand build but not assigned reviewer until build report clean labels Oct 7, 2024
@bioc-issue-bot
Copy link
Collaborator

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

@Kayla-Morrell
Copy link

@TylerSagendorf - 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.

General package development

  • REQUIRED: Package files exceed the 5MB size limit.

DESCRIPTION

  • SUGGESTION: Consider adding these automatically suggested biocViews:
    GeneExpression, Transcription, Sequencing, ATACSeq, Microarray, Metabolomics,
    Proteomics, Epigenetics, Cheminformatics, Transcriptomics,
    DifferentialExpression, ExperimentalDesign, Normalization, Preprocessing,
    Bayesian, Regression, ExonArray, RNASeq, OneChannel, TwoChannel, MicroRNAArray,
    mRNAMicroarray, ProprietaryPlatforms, CellBiology, BiomedicalInformatics,
    FunctionalGenomics, SystemsBiology, ImmunoOncology, AlternativeSplicing,
    DifferentialSplicing, BatchEffect, MultipleComparison, QualityControl,
    TimeCourse, DataImport

NAMESPACE

  • REQUIRED: Function names should use camelCase or snake_case and should not include '.'.

R code

  • SUGGESTION: For formatting reasons, consider shorter lines. There are 4 lines that are > 80 characters long.
  • SUGGESTION: For formatting reasons, consider multiples of 4 spaces for line indents. There are 257 lines that are not.

Best,
Kayla

@bioc-issue-bot
Copy link
Collaborator

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

@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 the Bioconductor Single Package Builder.

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): TMSig_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/TMSig 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: 1c4cf03b82fc1700252730509afde58daa624142

@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 the Bioconductor Single Package Builder.

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 Single Package Builder:
Linux (Ubuntu 24.04.1 LTS): TMSig_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/TMSig to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@TylerSagendorf
Copy link
Author

@Kayla-Morrell Thank you for taking the time to review the package. I have either addressed these points in the latest changes or provided reasoning as to why they weren't addressed below.

  1. DESCRIPTION: these biocViews are not strongly related to the TMSig package. My guess is they got suggested because of the limma dependency or some packages in the Imports field.
  2. NAMESPACE: cameraPR.matrix is an S3 method (not S4 only because limma::cameraPR is not), so I don't believe I'll be able to remove the '.'
  3. Multiples of 4 spaces for line indents: the 257 lines flagged are all cases like those below. If possible, I would like to keep them as-is since the extra blank space at the beginning significantly improves my ability to read the code, and it somewhat reduces the number of lines


Best,
Tyler

@Kayla-Morrell
Copy link

@TylerSagendorf - Thank you for making the necessary changes and/or providing reasoning. I have looked over everything and it all looks good. I'm more than happy to accept the package.

Best,
Kayla

@Kayla-Morrell Kayla-Morrell 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 Oct 24, 2024
@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.

@lshep
Copy link
Contributor

lshep commented Oct 25, 2024

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

https://bioconductor.org/packages/TMSig

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.

@lshep lshep closed this as completed Oct 25, 2024
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

4 participants