Closed kkrismer closed 6 years ago
Hi @kkrismer
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: transite
Title: RNA-binding protein motif analysis
Version: 0.99.0
Authors@R:
c(person(given = "Konstantin",
family = "Krismer",
role = c("aut", "cre", "cph"),
email = "krismer@mit.edu",
comment = c(ORCID = "0000-0001-8994-3416")),
person(given = "Anna",
family = "Gattinger",
role = "aut",
email = "anna.gattinger@risc-software.at",
comment = c(ORCID = "0000-0001-7094-9279")),
person(given = "Michael",
family = "Yaffe",
role = c("ths", "cph"),
email = "myaffe@mit.edu",
comment = c(ORCID = "0000-0002-9547-3251")),
person(given = "Ian",
family = "Cannell",
role = "ths",
email = "icannell@mit.edu",
comment = c(ORCID = "0000-0001-5832-9210")))
Maintainer: Konstantin Krismer <krismer@mit.edu>
Description: transite is a computational method that allows
comprehensive analysis of the regulatory role of RNA-binding proteins
in various cellular processes by leveraging preexisting gene
expression data and current knowledge of binding preferences of
RNA-binding proteins.
License: MIT + file LICENSE
Depends:
R (>= 3.5)
Imports:
BiocGenerics (>= 0.26.0),
Biostrings (>= 2.48.0),
dplyr (>= 0.7.6),
GenomicRanges (>= 1.32.6),
ggplot2 (>= 3.0.0),
gridExtra (>= 2.3),
methods,
parallel,
Rcpp (>= 0.12.18),
scales (>= 1.0.0),
stats,
TFMPvalue (>= 0.0.8),
utils
Suggests:
knitr (>= 1.20),
rmarkdown (>= 1.10),
roxygen2 (>= 6.1.0)
LinkingTo:
Rcpp (>= 0.12.18)
VignetteBuilder:
knitr
biocViews: GeneExpression, Transcription,
DifferentialExpression, Microarray, mRNAMicroarray, Genetics,
GeneSetEnrichment
Encoding: UTF-8
RoxygenNote: 6.1.0
SystemRequirements: C++11
Add SSH keys to your GitHub account. SSH keys will are used to control access to accepted Bioconductor packages. See these instructions to add SSH keys to your GitHub account.
A reviewer has been assigned to your package. Learn what to expect during the review process.
IMPORTANT: Please read the instructions for setting up a push hook on your repository, or further changes to your repository will NOT trigger a new build.
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on Linux, Mac, and Windows.
On one or more platforms, the build results were: "skipped, 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.
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on Linux, Mac, and Windows.
Congratulations! The package built without errors or warnings on all platforms.
Please see the build report for more details.
Received a valid push; starting a build. Commits are:
f959f92 Version bump
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on Linux, Mac, and Windows.
Congratulations! The package built without errors or warnings on all platforms.
Please see the build report for more details.
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on Linux, Mac, and Windows.
Congratulations! The package built without errors or warnings on all platforms.
Please see the build report for more details.
I've reviewed your package. It looks great, but I have a few concerns. [REQUIRED] tags indicate changes that must be made or require an explanation. [CONSIDER] tags are advisable but not required. Please message me back when you are finished making changes.
GENERAL
BiocParallel
package in place of parallel
.R/RcppExports.R
:L126 as a user, I don't know what e
should be.
Maybe it could be a numeric(1)
or maybe a logical(1)
, but it's not
immediately clear. It's advisable to look back though the documentation and try
to clear these things up.R/combine-p-values.R
method <- match.arg(method)
in the
beginning of this function to select just the given argument to method
.
You can then just use method
instead of method[1]
.R/data.R
R/k-mer-based.R
match.arg()
in this function as well.R/main.R
cache
in this function? Instead of
creating a local directory, can the default simply be tempdir()
. Tempdirs
are erased upon the end of the R session. If the cache directory needs to
persist, you may consider using Biocondcutor's BiocFileCache
package.R/matrix-based.R
cache
as before.Sys.sleep()
because if this occurs in the context of the loop, this function can
significantly increase the time required for the run. It, however, may be
necessary here since it may be occurring in the context of semaphore, i.e.
locking and unlocking this motif.cache.lock
file. Is Sys.sleep()
indeed
necessary? If so, could it be shorter in case it is used in a loop?R/misc.R
Motif
is declared here. This class
is using the S3 class system, whereas the Biocondcutor project uses the S4 class
system. Please convert this class to S4.
http://www.bioconductor.org/help/course-materials/2010/AdvancedR/S4InBioconductor.pdfR/spectrum.R
SpectrumScore
also appears to be an S3 class as well. Please
modify this class to S4 as well.tests
testthat
package.Received a valid push; starting a build. Commits are:
0aeb21d Using argument verification with match.arg 5cd0732 Changed default cache path to temp dir 566eb18 Reduced sleep time in semaphore a67a3f4 Improved documentation of data objects 31dd3c4 Changed default cache path to temp dir 9e05107 Improved parameter documentation ac9b800 Cosmetic changes 70bc0dd Converted SpectrumScore from S3 to S4 class 3836873 Converted class Motif from S3 to S4 70d0122 Added importFrom annotation a538023 Added runnable examples to function documentations dd4a484 Added version to import 83e5d28 Version bump
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on Linux, Mac, and Windows.
Congratulations! The package built without errors or warnings on all platforms.
Please see the build report for more details.
Hi @dvantwisk,
Thank you for your kind and helpful feedback!
I have changed all required points as suggested and followed your recommendation on all but two points labeled as consider. I am happy to elaborate on the exact changes, if necessary.
Cheers, Konstantin
I like the changes so far. It seems that the Sys.sleep()
needs to be called even if for a short period of time, correct? My only remaining issue is the naming of some of your classes and methods.
The Bioconductor suite of packages involves a hierarchical system of packages that inherit classes and generics from each other. Problems may arise if the same names are used for the classes and generics that are used at a higher level of the hierarchy. For this reason, I ask that you differentiate your class and generic names a little more. Motif
sounds like a very standard name for a class and it may have been declared elsewhere since many packages deal with motifs. It would be better to rename this class to something like TransiteMotif
. The same goes for many of the s4 generic names that you are instantiating (e.g. slope
and degree
seem far to general and seem to be in use by other packages). Lastly, it is common to use "camel-case" instead of "dot-notation" for s4 methods. For example, instead of motif.matrix
almost look like an s3 method meant to dispatch on matrix. It would be more proper to name this motifMatrix
instead. As you can see, "camel-case" has the first word as under-case and every word after that in capitalized.
These changes will help your package play better with other packages currently present in Bioconductor. After these changes are made I should be able to accept the package.
About Sys.sleep()
: Yes, it is used to periodically check whether the motif cache file is still in use by another process - I think Sys.sleep()
is necessary in this case.
I've renamed the Motif class and made the method names from both classes more specific to avoid conflicts with other R/Bioconductor methods. Also, they are in camel case now.
Dear Package contributor,
This is the automated single package builder at bioconductor.org.
Your package has been built on Linux, Mac, and Windows.
Congratulations! The package built without errors or warnings on all platforms.
Please see the build report for more details.
Thank you for refactoring the class and method names, they look great now! I'm going to move to accept your package.
Your package has been accepted. It will be added to the Bioconductor Git repository and nightly builds. Additional information will be posed to this issue in the next several days.
Thank you for contributing to Bioconductor!
The master branch of your GitHub repository has been added to Bioconductor's git repository.
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/kkrismer.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 biocLite(\"transite\")
. The package 'landing page' will be created at
https://bioconductor.org/packages/transite
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 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.
I am familiar with the essential aspects of Bioconductor software management, including:
For help with submitting your package, please subscribe and post questions to the bioc-devel mailing list.