Bioconductor / Contributions

Contribute Packages to Bioconductor
131 stars 33 forks source link

artMS #848

Closed biodavidjm closed 5 years ago

biodavidjm commented 5 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 5 years ago

Hi @biodavidjm

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: artMS
Title: Analytical R tools for Mass Spectrometry
Version: 0.0.0.2018
Authors@R: c(
    person("David", "Jimenez-Morales", email = "biodavidjm@gmail.com", 
    role = c("aut", "cre", "cph")),
    person("John", "Von Dollen", email = "john.vondollen@ucsf.edu", 
    role = c("aut")),
    person("Alexandre", "Rosa Campos", email = "arosacampos@sbpdiscovery.org", 
    role = c("aut"))
    )
Maintainer: David Jimenez-Morales <biodavidjm@gmail.com>
Description: artMS provides a set of tools for the analysis of proteomics 
    label-free datasets. It takes as input the MaxQuant search result 
    output (evidence.txt file) and performs quality control, 
    relative quantification using MSstats, and downstream analysis 
    and integration. artMS also provides a set of functions to re-format 
    and make it compatible with other analytical tools, 
    including MIST, SAINT, and CompPASS.
License: GPL-3
URL: https://github.com/biodavidjm/artMS
BugReports: https://github.com/biodavidjm/artMS/issues
Depends: R (>= 3.5.0)
Imports:
  biomaRt,
  bit64,
  ComplexHeatmap,
  corrplot,
  data.table,
  ggdendro,
  getopt,
  ggplot2,
  graphics,
  grDevices,
  grid,
  limma,
  MSstats,
  org.Hs.eg.db,
  pheatmap,
  plotly,
  plyr,
  RColorBrewer,
  reshape2,
  seqinr,
  stats,
  shiny,
  stringr,
  utils,
  VennDiagram,
  yaml
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.0.1
Roxygen: list(markdown = TRUE)
Suggests: knitr,
    rmarkdown,
    testthat
VignetteBuilder: knitr
mtmorgan commented 5 years ago

looks like you forgot to write a vignette?

biodavidjm commented 5 years ago

Right! Will add it soon

mtmorgan commented 5 years ago

Will you be able to update your package or should we move this issue to inactive?

biodavidjm commented 5 years ago

Yes! please, check it out. The vignette is ready. I have also been very actively working on other issues of the package to make sure is solid enough (please, check stats and to the lastest commits to find out more).

bioc-issue-bot commented 5 years ago

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.

bioc-issue-bot commented 5 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: "WARNINGS, 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.

biodavidjm commented 5 years ago

All the errors and warnings have been addressed. Please, check it out

LiNk-NY commented 5 years ago

Hi David, @biodavidjm It looks like you still have errors. Could you bump the version for another build? Thanks.

biodavidjm commented 5 years ago

@LiNk-NY Done! package absolutely free of warnings and errors both locally and on travis. Please, check it out (and if it fails, please, send me the log)

LiNk-NY commented 5 years ago

David, @biodavidjm it looks like the build is not being triggered. Did you make any changes to the webhook?

bioc-issue-bot commented 5 years ago

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

bb6265e Merging read_evidence_file functions to checkIfFil...

biodavidjm commented 5 years ago

Sorry @LiNk-NY I have just added bioconductor to web hooks following this guideline. it looks like it is working now

bioc-issue-bot commented 5 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 5 years ago

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

bd58566 Updating DESCRIPTION - Addresses error: "No biocV...

bioc-issue-bot commented 5 years ago

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

1b9d09e Update DESCRIPTION amend #2

bioc-issue-bot commented 5 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 5 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 5 years ago

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

35ff22c Update version after pull request version updated...

bioc-issue-bot commented 5 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 5 years ago

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

0f7c7f6 Adding examples to annotationUniprot #28 #2

bioc-issue-bot commented 5 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.

biodavidjm commented 5 years ago

@LiNk-NY why do you think I am getting this error only for OS X? Thanks!

LiNk-NY commented 5 years ago

Hi David, @biodavidjm

The error is from BiocCheck. 80% of your functions should have runnable examples:

* Checking exported objects have runnable examples...
    * ERROR: At least 80% of man pages documenting exported objects
      must have runnable examples. The following pages do not:
      artms_analysisQuantifications.Rd, artms_annotateSpecie.Rd,
  artms_annotationUniprot.Rd, artms_avg_intensity_RT.Rd,
  artms_changeColumnName.Rd, artms_dataPlots.Rd,
  artms_enrichForComplexes.Rd, artms_enrichLog2fc.Rd,
  artms_enrichProfiler.Rd, artms_evidenceQC.Rd,
  artms_evidenceToMISTformat.Rd, artms_evidenceToSaintExpressFormat.Rd,
  artms_filterMaxqData.Rd, artms_generatePhSiteExtended.Rd,
  artms_isEvidenceNewVersion.Rd, artms_mapUniprot2entrezGeneName.Rd,
  artms_mergeEvidenceKeysByFiles.Rd, artms_mergeMaxQDataWithKeys.Rd,
  artms_msstats_summary.Rd, artms_plotCorumEnrichment.Rd,
  artms_plotHeatmapQuant.Rd, artms_proteinToSiteConversion.Rd,
  artms_quantification.Rd, artms_replicatePlots.Rd,
  artms_resultsWide.Rd, artms_SILACtoLong.Rd, artms_spectralCounts.Rd,
  artms_volcanoPlot.Rd, artms_writeContrast.Rd

You have quite a number of objects that are undefined global functions or variables (see the list below). Make sure you are clearly defining where these are coming from. Thanks.

Undefined global functions or variables:
  ..count.. .artms_plotNumberProteinsAbundance ABUNDANCE AbMean
  Abundance BioReplicate BioReplicates Bioreplica Comparison
  ComplexName Condition Conditions Contaminant FEATURE GENENAME
  GROUP_ORIGINAL Gene Intensity IsotopeLabelType Label MODIFICATION
  Modifications PROTEIN PTMone PTMsite Prey Protein Proteins RawFile
  ReproBioreplicaCount ReproConditionCount SUBJECT_ORIGINAL SYMBOL
  Specie TR adj.pvalue artms_data_corum_mito_database category cluster
  iLog2FC iPvalue imputedDFext isPtm log2FC log2fc_file org.Sc.sgd.db
  output_dir pathogen.ids pearson plotHeat prot_names ptm_site pvalue
  res_index sample_name tr1 tr2 uniprot_ac uniprot_id value ymax ymin
bioc-issue-bot commented 5 years ago

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

6683b63 Addressing the "no visible binding for global vari...

bioc-issue-bot commented 5 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.

biodavidjm commented 5 years ago

Hi @LiNk-NY

I have fixed the issue regarding the undefined objects. However, I have a problem with the runnable examples. Let me explain it.

Even though I have provided examples for all the functions, I added the label \donttest. This is due to the following reasons:

  1. artMS relies on very large input datasets (the smallest example that I have found is not less than 40MB)
  2. Some of the functions take some time due to the complexity of the analysis (and using these large files), and I am afraid that compiling the package would take way longer than the allowed time.
  3. Many of the functions generate quite a lot of output files that, if run as an example, could end up unseen somewhere in the system of the (unexperienced) users.

We are addressing a broad audience, mainly users with basic R knowledge who are going to be able to run a sophisticated analysis of Mass Spectrometry data (mostly proteomics) thanks to this package in a very easy way. My proposed solution is to make the vignettes as good as possible and provide in the vignettes examples of these large files through Bioconductor ExperimentData resource. Would that work?

Any advice would be greatly appreciated! Thanks so much!

bioc-issue-bot commented 5 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.

LiNk-NY commented 5 years ago

Hi David, @biodavidjm

We rather not have 'donttest' or 'dontrun' examples because that usually creates stale code in the long run. We prefer runnable examples for most of the functions.

Perhaps you can add a small dataset to the package under inst/extdata (raw files) or data (processed, exported, and documented data) to use for the examples. You may even want to generate data in a script under the R folder.

For larger datasets, ExperimentHub is the better option.

Keep in mind that there are time restrictions when checking the package. This factors in when using large datasets in the vignette.

Regards, Marcel

bioc-issue-bot commented 5 years ago

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

1e04370 add example to evidenceQC It required to fix `art...

bioc-issue-bot commented 5 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 5 years ago

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

710a69b Removed File too large #2 #37 #4

bioc-issue-bot commented 5 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 5 years ago

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

168b850 Runnable example for artms_avg_intensity Also fix...

bioc-issue-bot commented 5 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 5 years ago

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

52d33c9 Deleting extdata - Checking the effect on the com...

bioc-issue-bot commented 5 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: "ABNORMAL". 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 5 years ago

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

3620703 Runnable example for artms_changeColumnName #37 #...

bioc-issue-bot commented 5 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 5 years ago

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

86a7dcf Runnable example for artms_filterMaxqData and rena...

bioc-issue-bot commented 5 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 5 years ago

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

2fd4a39 Runnable example to the new artms_mergeEvidenceAnd...

bioc-issue-bot commented 5 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 5 years ago

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

d9c163c Runnable example for artms_resultsWide (and fixing...

bioc-issue-bot commented 5 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 5 years ago

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

9598621 Making artms_writeContrast internal function - Fi...

bioc-issue-bot commented 5 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 5 years ago

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

100bf8c Runnable example for artms_annotationUniprot and o...

bioc-issue-bot commented 5 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 5 years ago

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

d3298b4 Making .artms_enrichForComplexes an internal funct...