Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

(inactive) bioAnno #1404

Closed guokai8 closed 3 years ago

guokai8 commented 4 years ago

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

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

e9ed126 Update DESCRIPTION

bioc-issue-bot commented 4 years ago

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: "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.

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

ac0b5df Update DESCRIPTION

bioc-issue-bot commented 4 years ago

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: "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.

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

eba6400 Update DESCRIPTION

bioc-issue-bot commented 4 years ago

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: "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.

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

12cb8da Update DESCRIPTION

bioc-issue-bot commented 4 years ago

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.

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

cc37a76 Update DESCRIPTION

bioc-issue-bot commented 4 years ago

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.

guokai8 commented 4 years ago

Hi @hpages @bioc-issue-bot , I find an issue by using basename to extract the base name from a full path. Now I just comment the example for the new getTable function. Please go ahead to check if other part looks good to you. Thanks! Kai

guokai8 commented 4 years ago

Hi @hpages @bioc-issue-bot , I am not sure if you got my revised comments. Please go ahead to check if it make sense to you.

1. I'll start with the documentation. It has many English mistakes and also mistakes like this one in the vignette:

BiocManager::install("VennDetail")

where this is supposed to be the command for installing the bioAnno package. Response: Sorry for the error. I replace with the new version

2. Or this one in the man page for fromAnnHub():

build annotation package for yeast

   fromAnnHub(species = "celegans", install = FALSE)

Response: fixed the typo in man page

3. Please re-read and check carefully all your documentation (man pages and vignette) and make sure it is clear, accurate, and concise. It needs a lot of improvement.

Response: I revised the vignette and man pages. Thanks for your suggestions. I am not good at writing man pages and vignette.

4. Also it is not good design that your functions install and/or remove packages in a somewhat obscure manner. They should focus on making annotations. If these annotations end up in a package, then print a clear error message at the end of your function explaining where that package can be found and how to install it. The user will decide if they want to install it or not. But they should be able to take a look at it before they do so.

Response: I add function to display the whole path of the package and how to install it if the user choose not to install it. And I also add the function getTable to help the user to extract annotation tables if the user just want have annotation table instead of installing the whole package.

Thanks! Kai

hpages commented 4 years ago

Hi @guokai8 ,

No need to post 3 times the same long comment. One time is enough and any re-post of an earlier comment is just adding noise to the issue.

Also no need to tag bioc-issue-bot. As its name suggests, this is a bot, not a real person.

The last build/check for bioAnno is from April 21st and the results for Mac are missing. Please bump the version of the package again in order to trigger a new build/check and get a full report on the 3 platforms.

Thanks!

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

8b20c8e Update DESCRIPTION

guokai8 commented 4 years ago

Hi @hpages, Sorry about this. I thought you may miss the comment. I update the version now. Thanks! Kai

bioc-issue-bot commented 4 years ago

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.

guokai8 commented 4 years ago

Hi Herve, I am not sure if you receive the newest build report yet. Please let me know if you need anything. Thanks, Kai

On Thu, May 21, 2020 at 4:53 PM Hervé Pagès notifications@github.com wrote:

Hi @guokai8 https://github.com/guokai8 ,

No need to post 3 times the same long comment. One time is enough and any re-post of an earlier comment is just adding noise to the issue.

Also no need to tag bioc-issue-bot. As its name suggests, this is a bot, not a real person.

The last build/check for bioAnno is from April 21st and the results for Mac are missing. Please bump the version of the package again in order to trigger a new build/check and get a full report on the 3 platforms.

Thanks!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Bioconductor/Contributions/issues/1404#issuecomment-632365632, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACFKZGYJTQW3VXFOOIZLLDDRSWPFJANCNFSM4LB4TKAA .

-- Kai Guo

bioc-issue-bot commented 4 years ago

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.

hpages commented 4 years ago

Hi Kai,

The bioAnno package still needs a lot more attention in order to meet Bioconductor standards. As mentioned previously, the quality of the vignette and the documentation in general need to be improved. Take for example the HTML vignette: the output of the 2 commands called in the vignette represent more than 80% of its content! Each command produces an output that fills many screens. Furthermore, most of this output is not useful and is distracting. (Only the last 8-10 lines of each output is informative.)

Also, you need to format your code properly. For example, this code is very hard to read because it is very poorly formatted:

.extratGO <- function(taxid = NULL, species = NULL){
    # temp file
    if(is.null(taxid)){
    taxid <- .get.species.info(species)['tax.id']
    }
    tmp<-paste(
    tempfile(),
    "gz",
    sep = "."
    )
    # import Gene to Gene Ontology from NCBI Gene database
    download.file(
    "ftp://ftp.ncbi.nlm.nih.gov/gene/DATA/gene2go.gz",
    quiet = TRUE,
    destfile = tmp
    )
    # uncompress
    gunzip(tmp)
    # read the file (linux and windows)
    gene2go = fread(
    sub("\\.gz", "", tmp),
    verbose = FALSE,
    showProgress = FALSE
    )
    # select columns and rename
    gene2go <- unique(
    gene2go[,c(seq_len(4)), with = FALSE]
    )
    colnames(gene2go) <- c("taxid", "GID", "GO", "EVIDENCE")
    # convert columns in character
    gene2go[,
        `:=`(
        taxid = as.character(gene2go$taxid),
        GID = as.character(gene2go$GID)
        )
        ]
    # filter with taxid
    gene2go <- as.data.frame(gene2go)
    gene2go <- gene2go[gene2go$taxid == taxid,2:4]
    return(gene2go)
}

In particular:

Thanks! H.

guokai8 commented 4 years ago

Hi @hpages, I will revise the vignette and upload the new version. Thanks! Kai

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

934d2e4 Add files via upload

guokai8 commented 4 years ago

Hi @hpages , I revised the vignette, please help me to check it. And I also revised the code. Please go ahead to see if it looks good for you. I am so sorry to waste your time. Thanks! Kai

bioc-issue-bot commented 4 years ago

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: "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.

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

6fa1059 Update DESCRIPTION

bioc-issue-bot commented 4 years ago

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: "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.

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

fcb03f1 Update DESCRIPTION

bioc-issue-bot commented 4 years ago

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.

guokai8 commented 4 years ago

Hi @hpages, I have a question that some of my examples won't be able to run on the testing process on the bioconductor server which may due to the internet connection. How can I slove it? Thanks! Kai

guokai8 commented 4 years ago

Hi @hpages, Hope this one find you well. I just wonder if you have chance to check the package. Best, Kai

hpages commented 4 years ago

@lshep The link to the latest build report is invalid. Any idea what happened?

@guokai8 Please bump the version of the package so we get a new build report. Thanks! As for your concerns about some of your examples "that won't be able to run on the testing process on the bioconductor server which may due to the internet connection", can you provide more details? The Bioconductor servers have internet access so if the examples run for you they should run there. Therefore it's not clear to me what you are worrying about exactly.

bioc-issue-bot commented 4 years ago

Received a valid push; starting a build. Commits are:

f10d1b6 Update DESCRIPTION

guokai8 commented 4 years ago

Hi @hpages, I bump a new version now. The example is the function to build annotation package by using fromEnsembl(species = "Caenorhabditis elegans", anntype="KEGG") . It works well when I tested on my server and laptop. I am not sure what happened. Thanks! Kai

bioc-issue-bot commented 4 years ago

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. This link will be 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/bioAnno to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

guokai8 commented 4 years ago

Hi @hpages @mtmorgan , I just wonder if you have a chance to check the package. Thanks! Kai

hpages commented 4 years ago

Hi @guokai8,

Thanks for cleaning the vignette and improving the formatting of your code.

At the end of the (very short) vignette, you have:

  1. Contact information For any questions please contact guokai8@gmail.com

Bioconductor users are encouraged to ask questions about Bioconductor packages on the Bioconductor support site (https://support.bioconductor.org/). For reporting bugs, they should open an issue on GitHub. These are considered good practices and you should encourage you users to do that instead of contacting you directly by email.

The documentation is still poor. I already mentioned this a couple of times but unfortunately it has not improved much. This is the last time I will say it. So please take this seriously and improve it.

I'll just give you a few examples of things that you should improve. Note that these are only some examples and hopefully they give you an idea of why your documentation is not good enough. What you will need to do is revisit and improve all the man pages, not just the one that I'm going to look at now.

So for example the Description section in the man page for the ath dataset says:

ath include TAIR10 ID with matched ENTREZID information

This is way to "dry". First of all ath is a dataset but the user doesn't know that. Most man pages are for functions. Some man pages are for datasets. This must be made very clear. So start with something like:

The 'ath' dataset is etc..

Also please provide more details e.g. where the information is coming from, that is, where is the file that contains this mapping (provide the URL if possible) and how you extracted the dataset from the file. Also why not just use as.data.frame(org.At.tair.db::org.At.tairENTREZID) for this mapping? Are there any differences between the 2 mappings? If so, what are they?

Then the Format section says:

A matrix with two columns:

GID TAIR GENE ID

ENTREZID NCBI ENTREZID ID

As far as I can tell, the dataset is a data frame, not a matrix.

Also the names of the columns are GID and ENTREZID. So I don't know what information you are trying to give when you say that the columns are GID TAIR GENE ID and ENTREZID NCBI ENTREZID ID but these are certainly not the names of the columns. If you want to explain what the columns contain you need to use sentences. Simply writing things like GID TAIR GENE ID and ENTREZID NCBI ENTREZID ID in capital letters on 2 different lines is not how you explain what the columns are.

So that was an example. Now please go revisit and improve all your man pages.

You also need to pay more attention to the messages that are printed by your functions. For example:

fromAnnHub(species="ath", install=FALSE)
...
...
################################################################
Please find your annotation package in ...
/tmp/RtmpI1ySAa/org.ath.eg.db 
You can install it by using
install.packages("/tmp/RtmpI1ySAa/org.ath.eg.db,repos = NULL,type='source') 
################################################################
Here are the tables in the package org.ath.eg.db ...
gene_info genes go go_all go_bp go_bp_all go_cc go_cc_all go_mf go_mf_all map_counts map_metadata metadata path 
refseq symbol 
################################################################

but, unfortunately, the command you give for installing the annotation package is broken!

Also, how do we use this annotation package after we manage to install it? The vignette says almost nothing about what these annotation packages contain or how to use them and for what.

Unfortunately, I was not able to do much with this annotation package:

library(org.ath.eg.db)
ls(2)
# [1] "org.ath.eg"          "org.ath.eg_dbconn"   "org.ath.eg_dbfile"  
# [4] "org.ath.eg_dbInfo"   "org.ath.eg_dbschema" "org.ath.eg.db"      
# [7] "org.ath.egORGANISM" 

org.ath.eg_dbschema()

Warning messages:
1: In file(con, "r") :
  file("") only supports open = "w+" and open = "w+b": using the former
2: In max(ii) : no non-missing arguments to max; returning -Inf

It's broken!

This is disappointing given that you submitted the package 6 months ago. After all this time I was expecting to see a much better package.

Best, H.

guokai8 commented 4 years ago

Hi @hpages, Thanks for your kindly suggestions. I will try to fix all issues you mentioned. Best, Kai

guokai8 commented 3 years ago

Hi @hpages, I am sorry I am still working on these issues. I may need more time. Thanks! Kai

hpages commented 3 years ago

Hi Kai,

Any progress on this? Thanks,

H.

guokai8 commented 3 years ago

Hi, I am sorry I am working on it and will update it these days. Thanks! Kai

On Oct 16, 2020, at 12:16 AM, Hervé Pagès notifications@github.com wrote:

Hi Kai,

Any progress on this? Thanks,

H.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Bioconductor/Contributions/issues/1404#issuecomment-709790519, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACFKZGYT4EJW4OG3ODCOJ53SK7JL7ANCNFSM4LB4TKAA.

bioc-issue-bot commented 3 years ago

Received a valid push; starting a build. Commits are:

ea6eb18 Update DESCRIPTION

guokai8 commented 3 years ago

Hi @hpages , I just upload a new version of my package. I rewrite most of the vignette. Please go over it and let me know if it works for you. For some questions you had, such as the

library(org.ath.eg.db)
ls(2)
# [1] "org.ath.eg"          "org.ath.eg_dbconn"   "org.ath.eg_dbfile"  
# [4] "org.ath.eg_dbInfo"   "org.ath.eg_dbschema" "org.ath.eg.db"      
# [7] "org.ath.egORGANISM" 

org.ath.eg_dbschema()

Warning messages:
1: In file(con, "r") :
  file("") only supports open = "w+" and open = "w+b": using the former
2: In max(ii) : no non-missing arguments to max; returning -Inf

I am not sure how to fix it. Please help me if you have any suggestions. And I fix the issue

fromAnnHub(species="ath", install=FALSE)
...
...
################################################################
Please find your annotation package in ...
/tmp/RtmpI1ySAa/org.ath.eg.db 
You can install it by using
install.packages("/tmp/RtmpI1ySAa/org.ath.eg.db,repos = NULL,type='source') 

I am still working on some of the man pages. Thanks! Kai

bioc-issue-bot commented 3 years ago

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: "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. This link will be 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/bioAnno to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

guokai8 commented 3 years ago

Hi @hpages I git an error from the build report but it works fine when I test the command

fromEnsembl(species = "Caenorhabditis elegans", anntype="KEGG")

Thanks! Kai

bioc-issue-bot commented 3 years ago

Received a valid push; starting a build. Commits are:

3ba824b Update DESCRIPTION

bioc-issue-bot commented 3 years ago

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: "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. This link will be 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/bioAnno to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

hpages commented 3 years ago

Running fromEnsembl(species = "Caenorhabditis elegans", anntype="KEGG") on my laptop gives me a warning:

> fromEnsembl(species = "Caenorhabditis elegans", anntype="KEGG", install=FALSE) 
Gene Ontology are not list in your annotation database
Protein Family are not list in your annotation database
InterPro are not list in your annotation database
Reactome Pathway are not list in your annotation database
Populating genes table:
genes table filled
Populating gene_info table:
gene_info table filled
Populating symbol table:
symbol table filled
Populating entrezid table:
entrezid table filled
Populating go table:
go table filled
Populating path table:
path table filled
Populating pfam table:
pfam table filled
Populating interpro table:
interpro table filled
Populating reactome table:
reactome table filled
table metadata filled

'select()' returned many:1 mapping between keys and columns
Dropping GO IDs that are too new for the current GO.db
Populating go table:
go table filled
Populating go_bp table:
go_bp table filled
Populating go_cc table:
Populating go_mf table:
'select()' returned many:1 mapping between keys and columns
Populating go_bp_all table:
go_bp_all table filled
Populating go_cc_all table:
Populating go_mf_all table:
Populating go_all table:
go_all table filled
Creating package in /tmp/RtmpeBkSk2/org.Caenorhabditis.eg.db 
Now deleting temporary database file
################################################################
Please find your annotation package in ...
/tmp/RtmpeBkSk2/org.Caenorhabditis.eg.db 
You can install it by using
install.packages("/tmp/RtmpeBkSk2/org.Caenorhabditis.eg.db",repos = NULL,type='source') 
################################################################
Here are the tables in the package org.Caenorhabditis.eg.db ...
entrezid gene_info genes go go_all go_bp go_bp_all go_cc go_cc_all go_mf go_mf_all interpro map_counts map_metadata metadata path pfam reactome symbol 
################################################################
Warning message:
`select_()` is deprecated as of dplyr 0.7.0.
Please use `select()` instead.
This warning is displayed once every 8 hours.
Call `lifecycle::last_warnings()` to see where this warning was generated. 

Then loading the org.Caenorhabditis.eg.db package gives me another warning:

> library(org.Caenorhabditis.eg.db)
Loading required package: AnnotationDbi
Loading required package: stats4
Loading required package: BiocGenerics
Loading required package: parallel

Attaching package: ‘BiocGenerics’

The following objects are masked from ‘package:parallel’:

    clusterApply, clusterApplyLB, clusterCall, clusterEvalQ,
    clusterExport, clusterMap, parApply, parCapply, parLapply,
    parLapplyLB, parRapply, parSapply, parSapplyLB

The following objects are masked from ‘package:stats’:

    IQR, mad, sd, var, xtabs

The following objects are masked from ‘package:base’:

    anyDuplicated, append, as.data.frame, basename, cbind, colnames,
    dirname, do.call, duplicated, eval, evalq, Filter, Find, get, grep,
    grepl, intersect, is.unsorted, lapply, Map, mapply, match, mget,
    order, paste, pmax, pmax.int, pmin, pmin.int, Position, rank,
    rbind, Reduce, rownames, sapply, setdiff, sort, table, tapply,
    union, unique, unsplit, which.max, which.min

Loading required package: Biobase
Welcome to Bioconductor

    Vignettes contain introductory material; view with
    'browseVignettes()'. To cite Bioconductor, see
    'citation("Biobase")', and for packages 'citation("pkgname")'.

Loading required package: IRanges
Loading required package: S4Vectors

Attaching package: ‘S4Vectors’

The following object is masked from ‘package:base’:

    expand.grid

Warning message:
call dbDisconnect() when finished working with a connection 

The package is still broken:

> org.Caenorhabditis.eg_dbschema()

Warning messages:
1: In file(con, "r") :
  file("") only supports open = "w+" and open = "w+b": using the former
2: In max(ii) : no non-missing arguments to max; returning -Inf

I still have no idea what to do with these annotation packages, how to use them, for what use cases, etc...

I see almost no progress on the man pages.

Thanks, H.

guokai8 commented 3 years ago

Hi @hpages The first warning is due to the select function is deprecated which I can try to change it. I will modify it.

And I will figure out how to remove the second warning.

I didn’t use the dbschema function before since I just try to use the functions such as "keys, columns, mapIds ..." in the AnnotationDbi package to extract information from the package. I don't know how to add dbschema function here, I need some help. And I will add the way I use the annotation package when I had it.

The package I try to develop is tried to help users to have an easy way to store their annotation information and load into R. I am not really familiar with the dbschema and never use them before so I don't know what happened. Sorry about that.

I haven't finished the man pages for all the functions as I mentioned last time. I am working on it. Thanks! I really need some help. Best, Kai

guokai8 commented 3 years ago

And Please first to check the vignette and I still working on the man pages. Thanks! Kai

bioc-issue-bot commented 3 years ago

Received a valid push; starting a build. Commits are:

106f8f2 Update DESCRIPTION

guokai8 commented 3 years ago

Hi All, I am still working on the package. Best, Kai

On Nov 29, 2020, at 10:40 AM, bioc-issue-bot notifications@github.com wrote:

Received a valid push; starting a build. Commits are:

106f8f2 https://github.com/guokai8/bioAnno/commit/106f8f272b6d1dada20f46d1811cb85755391610 Update DESCRIPTION

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Bioconductor/Contributions/issues/1404#issuecomment-735421582, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACFKZGZ4GUP6LFWYB5RRK7LSSJ2OJANCNFSM4LB4TKAA.