Contributions icon indicating copy to clipboard operation
Contributions copied to clipboard

Submit HDO.db package

Open huerqiang opened this issue 2 years ago • 11 comments

Update the following URL to point to the GitHub repository of the package you wish to submit to Bioconductor

  • Repository: https://github.com/YuLab-SMU/HDO.db

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:

  • [x] The 'devel' branch for new packages and features.
  • [x] The stable 'release' branch, made available every six months, for bug fixes.
  • [x] 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.

huerqiang avatar Jul 31 '22 14:07 huerqiang

Hi @huerqiang

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: HDO.db
Type: Package
Title: A set of annotation maps describing the entire Human Disease Ontology
Version: 0.99.0
Authors@R: person(given = "Erqiang", family = "Hu", email = "[email protected]", role  = c("aut", "cre"))
Description: A set of annotation maps describing the entire Human Disease 
    Ontology assembled using data from DO.
    Its annotation data comes from 
    https://github.com/DiseaseOntology/HumanDiseaseOntology/tree/main/src/ontology.
License: Artistic-2.0
BugReports: https://github.com/GuangchuangYu/HDO.db/issues
biocViews: AnnotationData, FunctionalAnnotation
Encoding: UTF-8
LazyData: false
RoxygenNote: 7.2.1
Depends:
    R (>= 4.1.0)
Imports: 
    AnnotationDbi,
    methods
Suggests: 
    rmarkdown,
    knitr,
    testthat (>= 3.0.0)
VignetteBuilder: knitr
Config/testthat/edition: 3

bioc-issue-bot avatar Jul 31 '22 14:07 bioc-issue-bot

Thanks for submission, but please look at your compiled vignette. Vignette is not demonstrative. Should show some results like

> head(DOTERM)
         do_id                     Term
1 DOID:0001816             angiosarcoma
2 DOID:0002116                pterygium
3 DOID:0014667    disease of metabolism
4 DOID:0040001           shrimp allergy
5 DOID:0040002          aspirin allergy
6 DOID:0040003 benzylpenicillin allergy

You should also reflect some of the metadata in the vignette, such as the version of HDO.

vjcitn avatar Aug 05 '22 01:08 vjcitn

@vjcitn Thanks. We have updated the vignette.

huerqiang avatar Aug 05 '22 04:08 huerqiang

When I compile your package and look at vignette this is what I see: hdo

please make this a document that a user will be able to learn from. It should start with a prose paragraph indicating your purpose in contributing the package to Bioconductor. It would be nice if it indicated the scientific value with a narrated example. It would also be appropriate to give a sense of the hierarchy perhaps with a screenshot like

obopic

vjcitn avatar Aug 09 '22 09:08 vjcitn

@vjcitn Thank you for your suggestion, we have completed the relevant changes.

huerqiang avatar Aug 09 '22 13:08 huerqiang

@vjcitn Hi, we have completed the revision for a few days, is it possible to proceed further? Please see if there are any other issues, thanks.

huerqiang avatar Aug 19 '22 06:08 huerqiang

While I am passing this package, it is using obsolete methods.

> GO.db
GODb object:
| GOSOURCENAME: Gene Ontology
| GOSOURCEURL: http://current.geneontology.org/ontology/go-basic.obo
| GOSOURCEDATE: 2022-03-10
| Db type: GODb
| package: AnnotationDbi
| DBSCHEMA: GO_DB
| GOEGSOURCEDATE: 2022-Mar17
| GOEGSOURCENAME: Entrez Gene
| GOEGSOURCEURL: ftp://ftp.ncbi.nlm.nih.gov/gene/DATA
| DBSCHEMAVERSION: 2.1

Please see: help('select') for usage information
> HDO.db
Error: object 'HDO.db' not found
No suitable frames for recover()

The AnnotationDbi approaches are not used. The vignette uses as.list and toTable instead of select(). We need to update our contribution guidelines to ensure updated methods are used.

vjcitn avatar Aug 19 '22 17:08 vjcitn

This is also somewhat confusing:

> DO.db::DO()
Quality control information for DO:


This package has the following mappings:

DOANCESTOR has 6569 mapped keys (of 11002 keys)
DOCHILDREN has 1811 mapped keys (of 2279 keys)
DOOBSOLETE has 2374 mapped keys (of 2374 keys)
DOOFFSPRING has 1811 mapped keys (of 2279 keys)
DOPARENTS has 6569 mapped keys (of 11003 keys)
DOTERM has 6570 mapped keys (of 11003 keys)


Additional Information about this package:

DB schema: DO_DB
DB schema version: 1.0
> HDO.db::DO()
Quality control information for DO:


This package has the following mappings:

DOANCESTOR has 66768 mapped keys (of 11002 keys)
DOCHILDREN has 11034 mapped keys (of 2279 keys)
DOOFFSPRING has 66768 mapped keys (of 2279 keys)
DOPARENTS has 11034 mapped keys (of 11003 keys)
DOTERM has 11003 mapped keys (of 11003 keys)


Additional Information about this package:

DB schema: DO_DB
DB schema version: 2.0

maybe use HDO()?

vjcitn avatar Aug 20 '22 10:08 vjcitn

@vjcitn The HDO.db now support select() interface and we have changed DO() to HDO(). image

huerqiang avatar Aug 25 '22 19:08 huerqiang

@vjcitn Hi, has this package entered the review process?

huerqiang avatar Sep 03 '22 15:09 huerqiang

there is a sqlite file in your package exceeding size 5mb i am deliberating hiw to proceed need a few more days

vjcitn avatar Sep 03 '22 17:09 vjcitn

I am sorry to be taking so long with this. You have done a good job of emulating the GO.db and using the AnnotationDbi methods. I am still conflicted with the question of how to handle ontologies in Bioconductor. https://obofoundry.org/ontology/doid.html shows that this resource is frequently updated. The "traditional annotation" package processing is not ideal, but maybe we should do this for now. It allows the >5MB file, right @lshep ? Let's go along this route if that works.

vjcitn avatar Sep 10 '22 12:09 vjcitn

Yes. For a "traditional annotation" package that contains large files, the package can be reviewed here but the package will not be added to the git.bioconductor.org echosystem. The package will have to be manually uploaded by a team member any time there is an update to the package. The other alternative is to convert it to an annotationhub package and utilize that interface instead of having the large data file present in the package directly.

lshep avatar Sep 12 '22 11:09 lshep

@lshep Hi, how is the review progress of this package, do I need to make any changes?

huerqiang avatar Oct 01 '22 06:10 huerqiang

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.

bioc-issue-bot avatar Oct 03 '22 18:10 bioc-issue-bot

@huerqiang - The package has been added to our devel builder and the script to make it available is currently running. It should finish in the next couple of hours and then the package will be available in the devel version of Bioconductor. Thank you for your contribution!

Kayla-Morrell avatar Oct 03 '22 18:10 Kayla-Morrell