Meeting guidelines to submit a package to Bioconductor
1
0
Entering edit mode
@romanhillje-13023
Last seen 4.4 years ago

Hello everybody,

I'm planning to submit a package to Bioconductor soon but am having trouble meeting the guidelines. I've got two questions.

1) The functions provided in the package (cerebroApp) follow the analysis of scRNA-seq with Seurat. The input of those functions is the Seurat object itself. One of the requirements of Bioconductor is that at least 80% of the functions contained in the submitted package must have executable example code. My initial idea was to simply contain a very small Seurat object (few cells and few genes) in the package and load that in the example code. However, this increases the package size just enough so that it makes me run into another requirement which is that the package cannot be larger than 5 MB. Does anybody have an idea how to solve this?

2) In the DESCRIPTION file I already have the biocViews: lines, however, the package doesn't depend on any Bioconductor packages so there are no packages listed. During BiocCheck, it complains that ERROR: Add biocViews other than. When I remove that entry entirely, I get ERROR: No biocViews terms found. instead.

I'd be very happy if somebody could give me some advice.

Thank you!

package-submission • 1.1k views
ADD COMMENT
1
Entering edit mode

If this question ever makes its way to the BioC-devel mailing list (where package development-related discussions are meant to occur), I will add some of my thoughts on this matter.

ADD REPLY
0
Entering edit mode

My bad, I wasn't sure whether posting it here in the forum or sending an email to the devel mailing list would be more appropriate. Next time I know better. I might also send an email later because I'm curious about your comments.

ADD REPLY
1
Entering edit mode
shepherl 4.1k
@lshep
Last seen 2 days ago
United States
  1. If the package is very close to the 5 MB your reviewer might make an exception if there is no way to make the data smaller. They might also suggest submitting the data as an accompanied Data Experiment Package (preferably utilizing the ExperimentHub) . You might also look at the number of experiment data sets already in Bioconductor to see if there is example data/raw files that could already be used. There are a number of available scRNA data available in the ExperimentHub as well.

    library(ExperimentHub)
    hub = ExperimentHub()
    query(hub , "scRNA")
    

    There is also a Bioconductor community slack. I would suggest maybe asking if anyone knows or has provided such data in the #singlecellexperiment channel.

  2. biocViews is different than package dependencies. biocViews allow the package to be listed in different sections when listed here. On the left you will notice a drop down menu box of different terms, these are the biocViews . At minimum it seems you would want Technology and singleCell and perhaps a term related to RNA.

  3. The fact that the package doesn't depend/import/suggest any Bioconductor package is a "red flag" for us. Your package should rely on some Bioconductor packages. It is generally a requirement to utilize some Bioconductor common data structure at some point in your package; as well as possibly showing how your package will be integrated or utilized in conjunction with other Bioconductor related packages. Consider glancing at the Common Bioconductor methods and classes. Maybe it would be worth while and useful for the community to see if your package could include some conversion of the Seurat object to a Bioconductor object (if they wish but use the Seurat object through out your code base) ? I think maybe monocle package and maybe CellMixS might have done this at some point too with the SingleCellExperiment object? Although I'm not a familiar with the data structures. Exceptions to this have been made if there is a strong argument to justify.

Hope this helps.

ADD COMMENT
0
Entering edit mode

Thank you for the quick response! I'll have a look how to deal with the first issue (package size) but am relatively confident that I can meet that requirement one way or another. Also, I completely misunderstood what the biocViews was used for, thank you for the clarification! The third point has me a bit scared. My package provides a Shiny interface for visualization of scRNA-seq data (similar to the iSEE package), along with some functions for optional data pre-processing, so I would hope that this explains why I don't need any Bioconductor packages. I guess I'll just have to submit and see what happens during the revision process.

Thanks again for the feedback!

ADD REPLY
1
Entering edit mode

Again exceptions have been made but it would be great then if your package could be used with other common Bioconductor classes already implemented for single cell analysis in addition to the Seurat object. (I'm not sure how they handle it but maybe glance at monocle and maybe the scAlign packages) . It would probably be highly useful in the Bioconductor community to be able to use either the Seurat object or the SingleCellExperiment object. Cheers

ADD REPLY
0
Entering edit mode

Absolutely, I agree. There is already a function in the Seurat package that allows conversion of a Seurat object to a SCE object (and vice versa). I don't have any intention to replace it so for users of SCE objects this might be sufficient. I might have to give it a thorough test though.

ADD REPLY

Login before adding your answer.

Traffic: 770 users visited in the last hour
Help About
FAQ
Access RSS
API
Stats

Use of this site constitutes acceptance of our User Agreement and Privacy Policy.

Powered by the version 2.3.6