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

IdentifiHR #3579

Open
10 tasks done
ashleyweir1 opened this issue Sep 20, 2024 · 9 comments
Open
10 tasks done

IdentifiHR #3579

ashleyweir1 opened this issue Sep 20, 2024 · 9 comments
Labels
1. awaiting moderation submitted and waiting clearance to access resources 3d. needs interop Package must explicitly use Bioconductor structures and methods 3e. pending pre-review changes review has indicated blocking concern that needs attention

Comments

@ashleyweir1
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 @ashleyweir1

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: IdentifiHR
Type: Package
Title: IdentifiHR: predicting homologous recombination (HR) status for high-grade serous ovarian caricnoma (HGSC) using gene expression
Version: 0.99.0
Author: @R: 
    c(person(given = "Ashley L", 
  family = "Weir",
  role = c("aut", "cre"),
  email = "[email protected]",
  comment = c(ORCID = "0000-0002-3072-2616")))
Description: IdentifiHR is a trained logistic regression model that can predict HR status, being HR deficient (HRD) or HR proficient (HRP), in addition to the probability of a sample being HRD, using only gene expression. IdentifiHR first subsets raw gene expression counts collected from RNA sequencing to only those required for count transcormation and scaling (n = 2604 genes), and then uses the weighted abundances of 209 of these genes to predict HR status in HGSC.
Depends: R (>= 3.5.0)
License: GPL-3 + file LICENSE
Encoding: UTF-8
LazyData: true
Imports:
    dplyr,
    tibble,
    edgeR,
    glmnet,
    stats
RoxygenNote: 7.3.2
Suggests: 
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
VignetteBuilder: knitr
Config/testthat/edition: 3
biocViews: GeneExpression, RNASeq, Classification

@bioc-issue-bot bioc-issue-bot added the 1. awaiting moderation submitted and waiting clearance to access resources label Sep 20, 2024
@ashleyweir1
Copy link
Author

ashleyweir1 commented Sep 20, 2024

I have updated the DESCRIPTION file and made necessary changes. The updated version is now available on GitHub with version 0.99.1. Please consider the new version for review. Thank you!

@lshep
Copy link
Contributor

lshep commented Sep 24, 2024

Please adapt to also use standard Bioconductor object for gene expression, SummarizedExperiment

@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 24, 2024
@ashleyweir1
Copy link
Author

Hi, I have updated my main branch so that the package can also use SummarizedExperiment objects. However, I want to double check - do I have access to the Bioconductor git server, to push these changes to the remote branch? Thank you for your help.

@lshep
Copy link
Contributor

lshep commented Oct 8, 2024

at this point you do not have git access yet. We will check your github branch shortly

@lshep
Copy link
Contributor

lshep commented Oct 11, 2024

In the description your license is gpl3 + file license but I only see the gpl3
license included in the package. I think you should remove the + file license
as it does not seem needed

Could you also add a section in the vignette to show the use of the Bioconductor class. And update the man pages/documentation to indicate as such

@ashleyweir1
Copy link
Author

Hi,
Thank you for bringing these needed changes to my attention - I have updated the license listed in the DESCRIPTION and the vignette to document SummarizedExperiment objects as input, though I believe the man pages/documentation for the functions where this change is relevant have already been updated.
Kindly,
Ashley

@lshep
Copy link
Contributor

lshep commented Oct 16, 2024

Your vignette uses a data.frame of "rawCounts" not a SummarizedExperiment object? Did you not push to the github repo? Your man pages mention SummarizedExperiment but again use data.frame. Please add a SummarizedExperiment example in the vignette -- there are lots of available existing SummarizedExperiments in other packages or ExperimentHub if needed.

@ashleyweir1
Copy link
Author

Hi,
I apologise for the confusion.
I have added examples specifically and pushed to the repo.
Please let me know if anything else is needed - thank you for your help,
Ashley

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1. awaiting moderation submitted and waiting clearance to access resources 3d. needs interop Package must explicitly use Bioconductor structures and methods 3e. pending pre-review changes review has indicated blocking concern that needs attention
Projects
None yet
Development

No branches or pull requests

3 participants