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

PICB #3676

Open
10 tasks done
frahrend opened this issue Dec 5, 2024 · 3 comments
Open
10 tasks done

PICB #3676

frahrend opened this issue Dec 5, 2024 · 3 comments
Labels
1. awaiting moderation submitted and waiting clearance to access resources 3e. pending pre-review changes review has indicated blocking concern that needs attention

Comments

@frahrend
Copy link

frahrend commented Dec 5, 2024

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

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: PICB
Title: piRNA Cluster Builder
Version: 0.99.0
Authors@R: c(person("Pavol", "Genzor",  role = c("aut")),
    person("Aleksandr", "Friman", email="[email protected]",  role = c("aut")),
    person("Daniel", "Stoyko", role = c("aut")),
    person("Parthena", "Konstantinidou", email="[email protected]", role = c("aut")),
    person("Franziska", "Ahrend", email="[email protected]",  role = c("aut", "cre"), comment=c(ORCID = "0009-0004-7464-3444")),
    person("Zuzana", "Loubalova", email="[email protected]",  role = c("aut")), 
    person("Yuejun", "Wang", email="[email protected]",  role = c("aut")),
    person("Hernan", "Lorenzi", email="[email protected]",  role = c("aut")),
    person("Astrid D", "Haase", email="[email protected]",  role = c("aut")))
Description: piRNAs (short for PIWI-interacting RNAs) and their PIWI protein partners play a key role in fertility 
    and maintaining genome integrity by restricting mobile genetic elements (transposons) in germ cells. 
    piRNAs originate from genomic regions known as piRNA clusters. The piRNA Cluster Builder (PICB) is 
    a versatile toolkit designed to identify genomic regions with a high density of piRNAs. It constructs 
    piRNA clusters through a stepwise integration of unique and multimapping piRNAs and offers wide-ranging 
    parameter settings, supported by an optimization function that allows users to test different parameter 
    combinations to tailor the analysis to their specific piRNA system. The output includes extensive metadata 
    columns, enabling researchers to rank clusters and extract cluster characteristics. 
License: CC0
Encoding: UTF-8
Imports:
    utils,
    GenomicRanges,
    GenomicAlignments,
    GenomeInfoDb,
    Biostrings,
    Rsamtools,
    data.table,
    IRanges,
    seqinr,
    stats,
    openxlsx,
    dplyr, 
    S4Vectors
Suggests: 
    knitr,
    rtracklayer, 
    testthat,
    BiocStyle,
    prettydoc,
    BSgenome,
    BSgenome.Dmelanogaster.UCSC.dm6,
    rmarkdown,
    ggplot2
VignetteBuilder: knitr
BugReports: https://github.com/HaaseLab/PICB/issues
URL: https://github.com/HaaseLab/PICB
biocViews: Genetics, GenomeAnnotation, Sequencing, FunctionalPrediction, Coverage, Transcriptomics
RoxygenNote: 7.3.2

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

lshep commented Dec 10, 2024

The current vignette is not appropriate for Bioconductor. All your code sections are eval=FALSE. Code must be evaluated.

@lshep lshep added the 3e. pending pre-review changes review has indicated blocking concern that needs attention label Dec 10, 2024
@frahrend
Copy link
Author

Dear @lshep
Thank you for your feedback! Previously, half of the code was evaluated, with the initial sections simply serving as an introduction to the package and its functions.
We have now combined these parts into a unified vignette, where the vast majority of code is directly executable. The only exceptions are (1) installation of dependencies and the package itself (as suggested) and (2) an optional method for loading the reference genome via a FASTA file. Preferred methods, such as using a BSgenome or providing a Seqinfo object, remain fully executable.
Thank you again for your feedback! An updated version is now available in our repo.

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 3e. pending pre-review changes review has indicated blocking concern that needs attention
Projects
None yet
Development

No branches or pull requests

3 participants