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

drugfindR #3151

Open
10 tasks done
AliSajid opened this issue Sep 13, 2023 · 29 comments
Open
10 tasks done

drugfindR #3151

AliSajid opened this issue Sep 13, 2023 · 29 comments
Assignees
Labels
2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place WARNINGS

Comments

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

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: drugfindR
Title: Investigate iLINCS for candidate repurposable drugs
Version: 0.99.547
Authors@R: c(
    person(given = c("Ali", "Sajid"),
 family = "Imami",
 role = c("aut", "cre"),
 email = "Ali.Sajid.Imami@gmail.com",
 comment = c(ORCID = "0000-0003-3684-3539")),
    person(given = c("Justin", "Fortune"),
 family = "Creeden",
 role = c("aut"),
 email = "Justin.Creeden@rockets.utoledo.edu",
 comment = c(ORCID = "0000-0003-3123-8401")),
    person(given = c("Evelyn", "Alden"),
 family = "Bates",
 role = c("aut"),
 email = "Evelyn.Bates@rockets.utoledo.edu",
 comment = c(ORCID = "0000-0002-4157-2481")),
    person(given = c("Smita"),
  family = "Sahay",
  role = c("aut"),
  email = "Smita.Sahay@rockets.utoledo.edu",
  comment = c(ORCID = "0009-0003-4377-8963")))
Description: This package provides a convenient way to access the
    LINCS Signatures available in the iLINCS database. These signatures include
    Consensus Gene Knockdown Signatures, Gene Overexpression signatures and
    Chemical Perturbagen Signatures. It also provides a way to enter your own
    transcriptomic signatures and identify concordant and discordant signatures
    in the LINCS database.
License: GPL-3 + file LICENSE
Encoding: UTF-8
URL: https://github.com/CogDisResLab/drugfindR
BugReports: https://github.com/CogDisResLab/drugfindR/issues
LazyData: false
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
biocViews: FunctionalPrediction, DifferentialExpression, GeneSetEnrichment
Imports:
    httr,
    magrittr,
    tibble,
    rlang,
    dplyr,
    purrr,
    readr,
    stringr,
    stats,
    lifecycle
Depends:
    R (>= 4.3.0)
Suggests:
    AnnotationDbi,
    biocthis,
    codemetar,
    devtools,
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
Config/testthat/edition: 3
Config/testthat/parallel: true
VignetteBuilder: knitr
X-schema.org-applicationCategory: Genomics
X-schema.org-keywords: LINCS, iLINCS, drug repurposing, drug discovery,
    transcriptomics, gene expression, gene knockdown, gene overexpression,
    chemical perturbagen, drugfindR
X-schema.org-isPartOf: https://bioconductor.org

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

lshep commented Sep 15, 2023

We like to see a clean package branch for inclusion and distribution, and extra features and integration controlled on different branches. There seems to be a lot of extra top level directories/files that should probably not be included by default to a user: codemeta.json, data-raw, raw, renv, renv.lock, utilities. If these are necessary please explain.

@AliSajid
Copy link
Author

Hi,

I can create a cleaner branch if necessary but almost all of the files that are in the repository are effectively necessary if someone is to clone the package and develop it.

Here's a brief description:

  • codemeta.json: A standard JSON-LD metadata file
  • data-raw and raw: These contain both scripts and the compressed data that is used to generate the internal data file (sysdata.rda)
  • renv and its related files for ensuring consistent development environment

The only one that is not standardized is utilities. I use that to store files I use elsewhere but that are not a core part of the code itself.

Most, if not all of these files are in the .Rbuildignore file and do not impact the build process itself.

If necessary, I can create a bioconductor-submission branch that removes a lot of these files, although I'd prefer not to.

@lshep
Copy link
Contributor

lshep commented Oct 6, 2023

We prefer as clean of a branch as possible and there are standards for where additional scripts and such should be stored; normally something like inst/scripts but I will move this forward to start getting builds and you can work the locations out with a reviewer.

@lshep lshep added the pre-check passed pre-review performed and ready to be added to git label Oct 6, 2023
@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 Oct 6, 2023
@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 Build System.

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 Bioconductor Build
System:
Linux (Ubuntu 22.04.2 LTS): drugfindR_0.99.559.tar.gz
macOS 12.6.5 Monterey: drugfindR_0.99.559.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/drugfindR to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@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 6, 2023
@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.

@bioc-issue-bot
Copy link
Collaborator

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

@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 Build System.

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 Bioconductor Build
System:
Linux (Ubuntu 22.04.2 LTS): drugfindR_0.99.560.tar.gz
macOS 12.6.5 Monterey: drugfindR_0.99.560.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/drugfindR 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: e37083839e28a83a3d5b8150c4cc0c6ae10b21e4

@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 Build System.

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 Bioconductor Build
System:
Linux (Ubuntu 22.04.2 LTS): drugfindR_0.99.561.tar.gz
macOS 12.6.5 Monterey: drugfindR_0.99.561.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/drugfindR 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 Oct 6, 2023
@bioc-issue-bot
Copy link
Collaborator

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

@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 Build System.

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 Bioconductor Build
System:
Linux (Ubuntu 22.04.2 LTS): drugfindR_0.99.564.tar.gz
macOS 12.6.5 Monterey: drugfindR_0.99.564.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/drugfindR 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: fd3ed32629e8a0be7d244097818d5d28edcb507c

@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 Build System.

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 Bioconductor Build
System:
Linux (Ubuntu 22.04.2 LTS): drugfindR_0.99.565.tar.gz
macOS 12.6.5 Monterey: drugfindR_0.99.565.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/drugfindR 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 WARNINGS and removed OK labels Oct 8, 2023
@bioc-issue-bot
Copy link
Collaborator

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

@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 Build System.

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 Bioconductor Build
System:
Linux (Ubuntu 22.04.2 LTS): drugfindR_0.99.566.tar.gz
macOS 12.6.5 Monterey: drugfindR_0.99.566.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/drugfindR 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 WARNINGS labels Oct 8, 2023
@hpages
Copy link
Contributor

hpages commented Oct 11, 2023

What happened to the vignette? It's empty!

@lshep
Copy link
Contributor

lshep commented Nov 20, 2023

@AliSajid Do you plan on revising the package? We will not review a package that does not have a vignette as it is part of Bioconductor standards. Please review Bioconductor contributions guidelines

@AliSajid
Copy link
Author

I'm sorry. I seem to have wires crossed. I'm revising and adding the vignette this week.

@lshep lshep added the 3c. inactive no activity from submitter for extended period of time and package not in a place to be accepted label Dec 21, 2023
@bioc-issue-bot
Copy link
Collaborator

This issue is being closed because there has been no progress
for an extended period of time. You may reopen the issue when
you have the time to actively participate in the review /
submission process. Please also keep in mind that a package
accepted to Bioconductor requires a commitment on your part to
ongoing maintenance.

Thank you for your interest in Bioconductor.

@bioc-issue-bot bioc-issue-bot changed the title drugfindR (inactive) drugfindR Dec 21, 2023
@bioc-issue-bot bioc-issue-bot removed the 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place label Dec 21, 2023
@AliSajid
Copy link
Author

AliSajid commented Feb 7, 2024

Hi,

I apologize for the delay. The vignette is updated and in the devel upstream,

@lshep lshep reopened this Feb 9, 2024
@bioc-issue-bot bioc-issue-bot changed the title (inactive) drugfindR drugfindR Feb 9, 2024
@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 3c. inactive no activity from submitter for extended period of time and package not in a place to be accepted labels Feb 9, 2024
@bioc-issue-bot
Copy link
Collaborator

Dear @AliSajid ,

We have reopened the issue to continue the review process.
Please remember to push a version bump to git.bioconductor.org
to trigger a new build.

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

@lshep lshep assigned hpages and DarioS and unassigned Kayla-Morrell and hpages Feb 9, 2024
@lshep
Copy link
Contributor

lshep commented Feb 9, 2024

Please remember to bump your version number to trigger a new build for the reviewer.

@bioc-issue-bot
Copy link
Collaborator

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

@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: "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): drugfindR_0.99.581.tar.gz
macOS 12.7.1 Monterey: drugfindR_0.99.581.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/drugfindR 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 WARNINGS and removed OK labels Feb 9, 2024
@DarioS
Copy link

DarioS commented Feb 11, 2024

  • Unclear relationship to existing Bioconductor packages. Imports field has zero Bioconductor packages. Please refer to Common Bioconductor Methods and Classes. Switching from tibble and data.frame to DataFrame is a good start.
  • Function names and parameters use snake_case style, not camelCase.See R Code chapter of developer's guide.
  • Empty R files. utilities.R has no code in it and is 0 bytes in size.
  • Vignette needs to have Bioconductor style. See Vignette and other accepted packages.
  • Vignettte needs spell checking. For example "inpur" should be "input" and "signagture" should be "signature".
  • Vignette code should be self-contained. It is not.
diffexp <- read_tsv("https://zenodo.org/records/10265182/files/dCovid_diffexp.tsv")

Packages that rely on access to web resources need to be written carefully. Web resources can change location, can be temporarily unavailable, or can be very slow to access and retrieve.

  • Each function requires a self-contained example. Currently, every example is a trivial one. See Examples.
#' @examples
#' TRUE
  • \description is identical for every function. Provide a meaningful paragraph for each one instead.

@AliSajid
Copy link
Author

I appreciate the comments and I'm working on addressing them. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place WARNINGS
Projects
None yet
Development

No branches or pull requests

6 participants