Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pcxn #501

Closed
8 tasks done
BioSok opened this issue Oct 2, 2017 · 20 comments
Closed
8 tasks done

pcxn #501

BioSok opened this issue Oct 2, 2017 · 20 comments

Comments

@BioSok
Copy link

BioSok commented Oct 2, 2017

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

  • Repository:

Confirm the following by editing each check box to '[x]'

  • I understand that by submitting my package to Bioconductor,
    the package source and all review commentary are visible to the
    general public.

  • I have read the Bioconductor Package Submission
    instructions. My package is consistent with the Bioconductor
    Package Guidelines.

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

  • My package addresses statistical or bioinformatic issues related
    to the analysis and comprehension of high throughput genomic data.

  • 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:

  • The 'devel' branch for new packages and features.
  • The stable 'release' branch, made available every six
    months, for bug fixes.
  • Bioconductor version control using Git
    (optionally via GitHub).

For help with submitting your package, please subscribe and post questions
to the bioc-devel mailing list.

@bioc-issue-bot
Copy link
Collaborator

Hi @BioSok

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: pcxn
Type: Package
Version: 0.99.0
Title: Pathway correlation coefficients and p values between pre-defined gene sets
Description: PCxN database contains correlation coefficients and p values between pre-defined gene sets within MSigDB H hallmark gene sets, MSigDB C2 CP (Canonical pathways), MSigDB C5 GO BP gene sets and Pathprint respectively.
Author: Sokratis Kariotis, Yered Pita-Juarez, Winston Hide, Wenbin Wei
Maintainer: Sokratis Kariotis <s.kariotis@sheffield.ac.uk>
License: MIT + file LICENSE
biocViews: ExperimentData, ExpressionData, MicroarrayData, GEO, Homo_sapiens_Data, OneChannelData, PathwayInteractionDatabase
NeedsCompilation: no
Suggests: org.Hs.eg.db, pheatmap, igraph, annotate
Imports: methods, grDevices, utils
Depends: R (>= 3.4)
LazyData: true
Encoding: UTF-8
RoxygenNote: 6.0.1

@bioc-issue-bot
Copy link
Collaborator

Your package has been approved for building. Your package is
now submitted to our queue.

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 bioc-issue-bot added 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place and removed 1. awaiting moderation labels Oct 2, 2017
@bioc-issue-bot
Copy link
Collaborator

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 following build report for more details:

http://bioconductor.org/spb_reports/pcxn_buildreport_20171002071128.html

@bioc-issue-bot
Copy link
Collaborator

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 following build report for more details:

http://bioconductor.org/spb_reports/pcxn_buildreport_20171002080754.html

@BioSok
Copy link
Author

BioSok commented Oct 3, 2017

Dear @vobencha , I believe the ERROR concerns the turned-off Tcl/Tk (and X11?) during compilation on Linux and OSX. I believe they are TRUE by default on the Windows server where the package builds fine.

@bioc-issue-bot
Copy link
Collaborator

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

ec678f8 version bump

@bioc-issue-bot
Copy link
Collaborator

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 following build report for more details:

http://bioconductor.org/spb_reports/pcxn_buildreport_20171004044821.html

@bioc-issue-bot
Copy link
Collaborator

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

51896d4 commented image line

@bioc-issue-bot
Copy link
Collaborator

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 following build report for more details:

http://bioconductor.org/spb_reports/pcxn_buildreport_20171004060838.html

@bioc-issue-bot
Copy link
Collaborator

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

d2bcc08 commented image line

@bioc-issue-bot
Copy link
Collaborator

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 following build report for more details:

http://bioconductor.org/spb_reports/pcxn_buildreport_20171004063205.html

@bioc-issue-bot
Copy link
Collaborator

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

98f50d0 commented image line

@bioc-issue-bot
Copy link
Collaborator

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 following build report for more details:

http://bioconductor.org/spb_reports/pcxn_buildreport_20171004064725.html

@bioc-issue-bot
Copy link
Collaborator

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

de7e3a8 commented image line

@bioc-issue-bot
Copy link
Collaborator

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 following build report for more details:

http://bioconductor.org/spb_reports/pcxn_buildreport_20171004065441.html

@bioc-issue-bot bioc-issue-bot added OK and removed ERROR labels Oct 4, 2017
@vobencha
Copy link

vobencha commented Oct 4, 2017

Hi,

It looks like we have a mixture of a software and experimental data package.

  • In general, experimental data packages do not contain R code. Functions that manipulate the data object belong in a software package that defines the class of the data object.
  • I would not recommend setting so many global variables. This usually means the existing functions don't have the proper input arguments to create the desired outcome. Please explain why you feel you need these:
    utils::globalVariables(c("pathprint.Hs.gs","pheatmap",
    "pathCor_pathprint_v1.2.3_dframe",
    "pathCor_CPv5.1_dframe", "gobp_gs_v5.1",
    "PathCor", "p.value", "Pathway.A", "Pathway.B"))
  • The name of the vignette file is inconsistent with the name of the package (PCxN vs pcxn).
  • I don't see the need to create the pxcn object. It is a matrix with a list. Why not reuse objects from Biobase, GSEABase, or SummarizedExperiment? Please consider re-packaging the data in an existing class and using the getters/setters already in place for that class.

Please explain a little more about what you want to accomplish with this package. Once that's cleared up I can give better guidance on how to restructure.

Valerie

@BioSok
Copy link
Author

BioSok commented Oct 4, 2017

Dear @vobencha ,

This package is meant to carry the functionality (mostly as queries) of the included functions using the present data. In the future this package will be extended and we want to build around the pcxn object and that is the reason we want to differentiate it. The specific fields of this object also coincide with other forms of existing pcxn (like a web-tool). This object should be plugged in future R packages which are part of a pipeline along with pcxn.

The global variables were used as it was the only successful way to gain access to those data from within the functions without encountering the NOTE: no visible binding for global variable. After your comment I will try to find the proper way to do this.

Thank you for your time and help!

With regards,
Sokratis

@vobencha
Copy link

Hi,

The data should be separate from the software functions unless you can pair it down to the required size which is <=4MB on disk: http://www.bioconductor.org/developers/package-guidelines/#correctness

Can you reduce the size and should we go ahead with pcxn as a software package?

Valerie

@BioSok
Copy link
Author

BioSok commented Oct 10, 2017

Hi,

Unfortunately all included data are necessary and cannot be loaded from another place, so I cant remove them. I will split the current package to a software (named pcxn) and a data package (named pcxnData). If I do the split (within few days) will both packages be included in the coming release? Thanks!

-Sokratis

@vobencha
Copy link

We'll do our best but there are no guarantees. Both packages must meet the guidelines and go through the full review process.

The process is described in detail here: https://github.com/Bioconductor/Contributions. The key steps are,

  • close this issue
  • open a new issue for the data package; once the data package passes build/check then
  • submit the software package to the same issue

Valerie

@BioSok BioSok closed this as completed Oct 10, 2017
@bioc-issue-bot bioc-issue-bot mentioned this issue Oct 10, 2017
8 tasks
@lshep lshep removed the 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place label Mar 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants