Closed dunstone-a closed 2 months ago
Hi @dunstone-a
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: multistateQTL
Type: Package
Date: 2024-02-23
Title: Toolkit for the analysis of multi-state QTL data
Version: 0.99.0
Authors@R: c(
person("Christina", "Del Azodi", role=c("aut"), email="cazodi@svi.edu.au"),
person("Davis","McCarthy", role=c("ctb"), email="dmccarthy@svi.edu.au"),
person("Amelia","Dunstone", role=c("cre", "ctb"), email="amelia.dunstone@svi.edu.au", comment=c(ORCID="0009-0009-6426-1529")))
Description: A collection of tools for doing various analyses of
multi-state QTL data, with a focus on visualization and interpretation.
The package 'multistateQTL' contains functions which can remove or impute
missing data, identify significant associations, as well as categorise features into global,
multi-state or unique. The analysis results are stored in a 'QTLExperiment' object,
which is based on the 'SummarisedExperiment' framework.
License: GPL-3
URL: https://github.com/dunstone-a/multistateQTL
BugReports: https://github.com/dunstone-a/multistateQTL/issues
Encoding: UTF-8
Depends:
QTLExperiment,
SummarizedExperiment,
ComplexHeatmap,
data.table,
collapse
Imports:
methods,
S4Vectors,
grid,
dplyr,
tidyr,
matrixStats,
stats,
fitdistrplus,
viridis,
ggplot2,
circlize,
mashr,
grDevices
Suggests:
testthat,
BiocStyle,
knitr,
covr,
rmarkdown
biocViews: FunctionalGenomics, GeneExpression, Sequencing, Visualization, SNP, Software
VignetteBuilder: knitr
RoxygenNote: 7.3.1
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
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 22.04.3 LTS): multistateQTL_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/multistateQTL
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
A reviewer has been assigned to your package for an indepth review. Please respond accordingly to any further comments from the reviewer.
The package is well thought-out and has good interoperability with existing Bioconductor infrastructure such as QTLExperiment
. I have noticed some minor issues to improve upon.
1:nStates
and use seq_along(nStates)
. See Syntax and Efficiency.beta_sd
, nNull
. camelCase is Bioconductor standard.is(qtle, "QTLExperiment")
or an S4 method which forces type-checking to be done by R.+
or base graphics and not.plotCompareStates
seems to use default ggplot2 style but plotSimulationParams
probably theme_bw()
.Received a valid push on git.bioconductor.org; starting a build for commit id: 0c1f843c97c4f7b60ad4acd041b965ee53bb6c75
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 22.04.3 LTS): multistateQTL_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/multistateQTL
to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.
Thank you so much for your review @DarioS ! Apologies that it has taken me a while to reply. I have addressed all of your comments:
Don't have separate installations of CRAN and Bioconductor packages in README file. Already listed in DESCRIPTION.
I have removed these from the README.
Avoid sequences such as
1:nStates
and useseq_along(nStates)
. See Syntax and Efficiency.
I have replaced all instances of 1:n
and 1:length(x)
with seq_len()
and seq_along()
.
Variable naming is inconsistent e.g.
beta_sd
,nNull
. camelCase is Bioconductor standard.
I have updated all functions to use only camelCase for inputs, changing the names of arguments which were in snake_case. For example I am now using betaSd, annotateRowsBy, annotateColsBy, assaySig, colRange, distMethod, threshSig, threshNull, colBoth, colDiverging, colNeither, colX, colY, etc.
I have kept state_id
the way it was because it is similar to spatial_id
of the SpatialExperiment package.
I retained row_km
and column_km
and show_row_names
as these arguments are passed directly to ComplexHeatmap so users familiar with ComplexHeatmap may already know these arguments.
Retained FUN
argument as it is similar to the FUN
argument from base R functions such as tapply.
Retained p.adjust.method
as it is similar to the p.adjust.methods
from the base R stats package.
Inputs are not type-checked. Use
is(qtle, "QTLExperiment")
or an S4 method which forces type-checking to be done by R.
I have added type-checking for the main input to the following plotting functions: plotUpSet, plotCompareStates and plotSimulationParams.
I also added type checking for the main inputs in: simPerformance, runTestMetrics, runPairwiseSharing, replaceNAs, qtleSimulate, qtleEstimate, callSignificance, getComplete, getSignificant and getTopHits.
Vignette has inconsistent and duplicated section numbering.
I've removed the manually typed in numbers for sections that were causing problems.
Plotting section should explain whether graphics are ggplot2 and customisable by
+
or base graphics and not. Consistency:plotCompareStates
seems to use default ggplot2 style butplotSimulationParams
probablytheme_bw()
.
I've added a description at the start of the plotting section to explain that all graphics are built using ggplot2 or ComplexHeatmap.
I've also updated the plotting functions to all use theme_classic()
.
Section "Pairwise sharing": Interpret the two blocks seen in the heatmap in a sentence or two. Visualizing multi-state QTL: Add interpretation after the plot.
I've added descriptions for both of these plots in the vignette.
Let me know if you have any further suggestions to improve the package.
Thanks, Amelia
The issues have been addressed.
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.
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/dunstone-a.keys is not empty), then no further steps are required. Otherwise, do the following:
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("multistateQTL")
. The package 'landing page' will be created at
https://bioconductor.org/packages/multistateQTL
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.
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]'
[x] I understand that by submitting my package to Bioconductor, the package source and all review commentary are visible to the general public.
[x] I have read the Bioconductor Package Submission instructions. My package is consistent with the Bioconductor Package Guidelines.
[x] I understand Bioconductor Package Naming Policy and acknowledge Bioconductor may retain use of package name.
[x] 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.
[x] My package addresses statistical or bioinformatic issues related to the analysis and comprehension of high throughput genomic data.
[x] 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.
[x] 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:
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.