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

NanoStringNCTools #1815

Closed
9 tasks done
rvitancol opened this issue Dec 16, 2020 · 44 comments
Closed
9 tasks done

NanoStringNCTools #1815

rvitancol opened this issue Dec 16, 2020 · 44 comments
Assignees
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution ERROR WARNINGS

Comments

@rvitancol
Copy link

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 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 Bioconductor code of conduct and
    agree to abide by it.

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 @rvitancol

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: NanoStringNCTools
Title: NanoString nCounter Tools
Description: Tools for NanoString Technologies nCounter Technology.
Version: 0.99.0
Encoding: UTF-8
Author: Patrick Aboyoun
Maintainer: Nicole Ortogero <nortogero@nanostring.com>, Zhi Yang <zyang@nanostring.com>
Depends: R (>= 3.6), Biobase, S4Vectors, ggplot2
Imports: BiocGenerics, Biostrings, ggbeeswarm, ggiraph, grDevices, IRanges,
         methods, pheatmap, RColorBrewer, stats, utils
Suggests: biovizBase, ggbio, RUnit, rmarkdown, knitr
License: Artistic-2.0
Collate: SignatureSet-class.R
         RccMetadata.R
         NanoStringRccSet-class.R
         NanoStringRccSet-validity.R
         NanoStringRccSet-accessors.R
         NanoStringRccSet-signatures.R
         NanoStringRccSet-subset.R
         NanoStringRccSet-utils.R
         NanoStringRccSet-summary.R
         NanoStringRccSet-qc.R
         NanoStringRccSet-normalize.R
         NanoStringRccSet-munge.R
         NanoStringRccSet-ggplot.R
         NanoStringRccSet-autoplot.R
         readRccFile.R
         readRlfFile.R
         readNanoStringRccSet.R
         writeNanoStringRccSet.R
         utils.R
         zzz.R
biocViews: GeneExpression, Transcription, CellBasedAssays, DataImport, 
 Transcriptomics, Proteomics, mRNAMicroarray, 
 ProprietaryPlatforms, RNASeq
VignetteEngine: knitr
VignetteBuilder: knitr

@bioc-issue-bot bioc-issue-bot added the 1. awaiting moderation submitted and waiting clearance to access resources label Dec 16, 2020
@bioc-issue-bot
Copy link
Collaborator

A reviewer has been assigned to your package. Learn what to expect
during the review process.

IMPORTANT: Please read this documentation for setting
up remotes to push to git.bioconductor.org. It is required to push a
version bump to git.bioconductor.org to trigger a new build.

Bioconductor utilized your github ssh-keys for git.bioconductor.org
access. To manage keys and future access you may want to active your
Bioconductor Git Credentials Account

@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 submitted and waiting clearance to access resources labels Dec 16, 2020
@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 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/NanoStringNCTools to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@rvitancol
Copy link
Author

AdditionalPackage: https://github.com/Nanostring-Biostats/GeomxTools

@bioc-issue-bot
Copy link
Collaborator

Hi @rvitancol,
Thanks for submitting your additional package: https://github.com/Nanostring-Biostats/GeomxTools.
We are taking a quick look at it and you will hear back from us soon.

@bioc-issue-bot bioc-issue-bot added the 1. awaiting moderation submitted and waiting clearance to access resources label Dec 18, 2020
@bioc-issue-bot
Copy link
Collaborator

Additional Package has been approved for building.

IMPORTANT: Please read this documentation for setting
up remotes to push to git.bioconductor.org. It is required to push a
version bump to git.bioconductor.org to trigger a new build.

@bioc-issue-bot bioc-issue-bot removed the 1. awaiting moderation submitted and waiting clearance to access resources label Dec 18, 2020
@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 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/GeomxTools to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: 7e152ffe7afda60d1f72a202391225266a8f724f

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

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: ff1d1eb312c96d092154f4d3a713a86c4e5de7b6

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

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: f4d30c6cb8fb1539635bd12e417837d4b7fa6706

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

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: 982d3bc731fbefd4ccd559af0a71a8322404d2da

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: 7d83cdedda9150ecaedc746042082b552aac7566

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

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

@rvitancol
Copy link
Author

Hi @nturaga, can we ask for the check.log from the R CMD check for the Windows build for GeomxTools? The error in the build report does not give us a clue where the error happens and this does not appear in our local R CMD CHECK.
This is the build error report excerpt:
< * checking whether package 'GeomxTools' can be installed ... ERROR>
<Installation failed.>
<See> <'C:/Users/pkgbuild/packagebuilder/workers/jobs/1815/982d3bc731fbefd4ccd559af0a71a8322404d2da/GeomxTools.Rcheck/00install.out' for details.>
<* DONE>

<Status: 1 ERROR>
<See>
<'C:/Users/pkgbuild/packagebuilder/workers/jobs/1815/982d3bc731fbefd4ccd559af0a71a8322404d2da/GeomxTools.Rcheck/00check.log'>
<for details.>

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: d914164ce3c745bf8a58d20e686b04d2dd0da0f7

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

@rvitancol
Copy link
Author

Notes on warnings and error related to R version: Tested these packages on the latest version of R, but we also require that they work on an older version (Depends: R (>= 3.6) for a report tool we use internally. The packages have undergone internal V&V as part of the report that we use internally.
Notes on warnings related to using "<-" in documentation: Replacement methods with "<-" causes an error in html since these are illegal symbols in file names on windows. Can we set the check to ignore these?

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: 3512b5565d3aaa97cfc8566b96c444dd92ee7d8b

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: 82d41fd6e8405c92fac6d1c52e10e86437f88c16

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

@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, WARNINGS".
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/NanoStringNCTools to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@nturaga
Copy link
Contributor

nturaga commented Dec 23, 2020

Notes on warnings and error related to R version: Tested these packages on the latest version of R, but we also require that they work on an older version (Depends: R (>= 3.6) for a report tool we use internally. The packages have undergone internal V&V as part of the report that we use internally.
Notes on warnings related to using "<-" in documentation: Replacement methods with "<-" causes an error in html since these are illegal symbols in file names on windows. Can we set the check to ignore these?

Yes, you can ignore these.

@nturaga
Copy link
Contributor

nturaga commented Dec 23, 2020

NanoStringNCTools review

R CMD build

ok

R CMD check

ok

DESCRIPTION

ok

NAMESPACE

  • being done manually, instead of by roxygen2. Please make sure
    functions/clases exported are all needed.

Build report warnings

  • WARNING: It seems you want to keep using R 3.6, and it's generating
    a warning. So ignore this one.

  • NOTE: These are the NOTES i'm particular about, please address
    these. The rest of them are also solvable for the most part (at
    least the ones you see on the linux builder)

  • * NOTE: Avoid sapply(); use vapply()
    
  • * NOTE: Consider adding runnable examples to the following man
    pages which document exported objects:
    geom_beeswarm_interactive.Rd, SignatureSet.Rd
    
    * NOTE: Consider adding a NEWS file, so your package news will be
    included in Bioconductor release announcements.
    
  • The windows build machine issue can be addressed by @hpages better.

R

  • There is a NOTE about indentation too(2 spaces vs 4 spaces), please
    check http://bioconductor.org/developers/how-to/coding-style/ .

  • Remove commented out lines of code.

  • I'm not sure why your zzz.R has the 'testPackage' function called
    inside of it. This usually isn't the way zzz.R is used.

    tests

    • ok

    man

  • ok

vignette

  • ok

@hpages
Copy link
Contributor

hpages commented Dec 30, 2020

Hi @nturaga , @rvitancol ,

The error on Windows seems to have occurred during R CMD INSTALL. Unfortunately the SBP doesn't show the output of this command so we don't have any details about this error. FWIW I can run R CMD INSTALL on NanoStringNCTools without any problem on riesling1 (another Windows builder, similar to tokay2). So I'd say let's just ignore the error reported by the SPB. We'll see how it goes the next time the SPB tries to build/check the package which should happen the next time its version gets bumped.

H.

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: 9c451811389d10403d86bf1494e4d45a6ee8cdd4

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

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: c6bd6f9dc9aa6ed79805e756f30edbcc20b306fa

@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, WARNINGS, skipped".
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/NanoStringNCTools to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@NicoleEO
Copy link

NicoleEO commented Jan 6, 2021

@nturaga I believe our packages are ready to go.
We have addressed the notes you highlighted above with the exception of one sapply that is used in a function that extends sapply to our class for users.
I did receive the below error in the last build, which seems to be an issue unrelated to our package.
image
In regards to our Additional Package, GeomxTools, it failed the build at the last check only because of R version requirements (3.6) so this one should also be ready.

@bioc-issue-bot
Copy link
Collaborator

Received a valid push on git.bioconductor.org; starting a build for commit id: d2eb6cc4bba5258a5f8ccd73fb4d025ad7893b9d

@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, WARNINGS, skipped".
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/NanoStringNCTools to trigger a new build.
A quick tutorial for setting up remotes and pushing to upstream can be found here.

@nturaga
Copy link
Contributor

nturaga commented Jan 22, 2021

Hi @NicoleEO ,

  • There is still one sapply() you have to fix in: NanoStringRccSet-utils.R (line 75, column 5). I'm otherwise ok with the changes you've made.

  • I'm actually not sure how I can accept this package as there is no build tarball produced on the Linux machine. @lshep or @hpages can answer maybe?

@lshep
Copy link
Contributor

lshep commented Jan 22, 2021

@nturaga why do you say there is no build tarball produced for Linux? The package only has a check warning for Linux. The package didn't build for Mac and as we explained multiple times this is likely do to Mac binaries not being produced on CRAN yet for Rdevel and should be ignored. This is confirmed by searching for the package not available https://cran.r-project.org/web/packages/ggiraph/index.html . Please ignore the Mac error and accept based on the other two build reports.

@NicoleEO
Copy link

@nturaga the last sapply is used to extend sapply to our class for users. Would it be possible to pass this one by as it is purposely kept as sapply to allow the user flexibility with unknown data types they may apply on?

@nturaga
Copy link
Contributor

nturaga commented Jan 22, 2021

That's fine. We suggest vapply() to specify "return" type rather than input type. Whatever you are writing with sapply, you can write with vapply.

@nturaga nturaga added 3a. accepted will be ingested into Bioconductor daily builder for distribution and removed 2. review in progress assign a reviewer and a more thorough review of package code and documentation taking place labels Jan 22, 2021
@bioc-issue-bot
Copy link
Collaborator

Your package has been accepted. It will be added to the
Bioconductor nightly builds.

Thank you for contributing to Bioconductor!

@NicoleEO
Copy link

@nturaga thanks for accepting. Does this also automatically apply to our additional package as well?

@nturaga
Copy link
Contributor

nturaga commented Jan 22, 2021 via email

@mtmorgan
Copy link
Contributor

The master branch of your GitHub repository has been added to Bioconductor's git repository.

To use the git.bioconductor.org repository, we need an 'ssh' key to associate with your github user name. If your GitHub account already has ssh public keys (https://github.com/rvitancol.keys is not empty), then no further steps are required. Otherwise, do the following:

  1. Add an SSH key to your github account
  2. Submit your SSH key to Bioconductor

See further instructions at

https://bioconductor.org/developers/how-to/git/

for working with this repository. See especially

https://bioconductor.org/developers/how-to/git/new-package-workflow/
https://bioconductor.org/developers/how-to/git/sync-existing-repositories/

to keep your GitHub and Bioconductor repositories in sync.

Your package will be included in the next nigthly 'devel' build (check-out from git at about 6 pm Eastern; build completion around 2pm Eastern the next day) at

https://bioconductor.org/checkResults/

(Builds sometimes fail, so ensure that the date stamps on the main landing page are consistent with the addition of your package). Once the package builds successfully, you package will be available for download in the 'Devel' version of Bioconductor using BiocManager::install("NanoStringNCTools"). The package 'landing page' will be created at

https://bioconductor.org/packages/NanoStringNCTools

If you have any questions, please contact the bioc-devel mailing list (https://stat.ethz.ch/mailman/listinfo/bioc-devel); this issue will not be monitored further.

@mtmorgan
Copy link
Contributor

The master branch of your GitHub repository has been added to Bioconductor's git repository.

To use the git.bioconductor.org repository, we need an 'ssh' key to associate with your github user name. If your GitHub account already has ssh public keys (https://github.com/rvitancol.keys is not empty), then no further steps are required. Otherwise, do the following:

  1. Add an SSH key to your github account
  2. Submit your SSH key to Bioconductor

See further instructions at

https://bioconductor.org/developers/how-to/git/

for working with this repository. See especially

https://bioconductor.org/developers/how-to/git/new-package-workflow/
https://bioconductor.org/developers/how-to/git/sync-existing-repositories/

to keep your GitHub and Bioconductor repositories in sync.

Your package will be included in the next nigthly 'devel' build (check-out from git at about 6 pm Eastern; build completion around 2pm Eastern the next day) at

https://bioconductor.org/checkResults/

(Builds sometimes fail, so ensure that the date stamps on the main landing page are consistent with the addition of your package). Once the package builds successfully, you package will be available for download in the 'Devel' version of Bioconductor using BiocManager::install("GeomxTools"). The package 'landing page' will be created at

https://bioconductor.org/packages/GeomxTools

If you have any questions, please contact the bioc-devel mailing list (https://stat.ethz.ch/mailman/listinfo/bioc-devel); this issue will not be monitored further.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3a. accepted will be ingested into Bioconductor daily builder for distribution ERROR WARNINGS
Projects
None yet
Development

No branches or pull requests

7 participants