Bioconductor / Contributions

Contribute Packages to Bioconductor
134 stars 33 forks source link

spaSim #2605

Closed fuerzhou closed 2 years ago

fuerzhou commented 2 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 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.

bioc-issue-bot commented 2 years ago

Hi @fuerzhou

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: spaSim
Title: Spatial point data simulator for tissue images
Version: 0.99.0
Date: 2022-02-16
Authors@R: 
    c(person("Yuzhou", "Feng", email = "yuzhou.feng@petermac.org", role = c("aut", "cre"),
 comment = c(ORCID = "0000-0002-2955-4053")),
    person("Anna", "Trigos", email = "anna.trigos@petermac.org", role = c("aut"),
 comment = c(ORCID = "xxxx-xxxx-xxxx-xxxx")))
Description: A suite of functions for simulating spatial patterns of cells in 
    tissue images. Output imagesare multitype point data in SingleCellExperiment 
    format. Each point represents a cell, with its 2D locations and cell type. 
    Potential cell patterns include background cells, tumour/immune cell clusters, 
    immune rings, and blood/lymphatic vessels.
License: Artistic-2.0
URL: https://trigosteam.github.io/spaSim/
BugReports: https://support.bioconductor.org/t/spaSim
biocViews: StatisticalMethod, Spatial, BiomedicalInformatics
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.2
Imports: 
    ggplot2,
    methods,
    stats,
    dplyr,
    spatstat.geom,
    SummarizedExperiment,
    spatstat.random,
    SingleCellExperiment
Depends: 
    R (>= 4.1.0)
LazyData: true
Suggests: 
    RefManageR,
    BiocStyle,
    knitr,
    testthat (>= 3.0.0),
    sessioninfo,
    rmarkdown,
    markdown
Config/testthat/edition: 3
VignetteBuilder: knitr
vjcitn commented 2 years ago

Please remove or qualify carefully

# install from GitHub
install.packages("devtools")
devtools::install_github("TrigosTeam/spaSim", ref = "dev")
fuerzhou commented 2 years ago

Thank you for the reminder. I have fixed it.

bioc-issue-bot commented 2 years ago

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

nturaga commented 2 years ago

Review

DESCRIPTION

ok

NAMESPACE

ok

NEWS

ok - make sure it can be parsed by utils::news().

R

https://github.com/TrigosTeam/spaSim/blob/09b9ff57000e54161cfbb9201177edd778a18c5a/R/simulate_background_cells.R#L50

There is a risk of failure if there are no validity checks for the parameters, please include them. And this risk increases as the number of parameters increase.

inst

man

ok, try to include more details on the parameters.

tests

ok

vignettes

ok

fuerzhou commented 2 years ago

Thank you @nturaga for the comments. Much appreciated.

The following issues have been solved :

There are two things that I would like to discuss with you:

fuerzhou commented 2 years ago

I tried pushing the updated version 0.99.1 to Bioconductor. However, I encountered an error:

$ git push upstream main
The authenticity of host 'git.bioconductor.org (34.192.48.227)' can't be established.
ED25519 key fingerprint is SHA256:h60zj69etEaWmD4S9vpI3KFRBvPlodTMxZjYpGh4ZjQ.
This key is not known by any other names
Are you sure you want to continue connecting (yes/no/[fingerprint])? yes
Warning: Permanently added 'git.bioconductor.org' (ED25519) to the list of known hosts.
Enumerating objects: 88, done.
Counting objects: 100% (88/88), done.
Delta compression using up to 8 threads
Compressing objects: 100% (57/57), done.
Writing objects: 100% (57/57), 22.82 KiB | 417.00 KiB/s, done.
Total 57 (delta 45), reused 0 (delta 0), pack-reused 0
remote: FATAL: W refs/heads/main packages/spaSim fuerzhou DENIED by fallthru
remote: error: hook declined to update refs/heads/main
To git.bioconductor.org:packages/spaSim.git
 ! [remote rejected] main -> main (hook declined)
error: failed to push some refs to 'git.bioconductor.org:packages/spaSim.git'

Looks like the issue was not the SSH. It might have something to do with hooks on remote. Could you please help me with this? Thank you!

lshep commented 2 years ago

Multiple issues:

  1. As mentioned in a previous message, you need to activate your git credentials account and add ssh keys to the account for access. https://git.bioconductor.org/BiocCredentials
  2. There is no main branch on bioconductor. Bioconductor currently uses master. See http://contributions.bioconductor.org/git-version-control.html#new-package-workflow particularly the note under #5 of the given new package workflow git .
bioc-issue-bot commented 2 years ago

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

fuerzhou commented 2 years ago

@lshep Thank you very much for the advice. I have now pushed the new version to Bioconductor.

bioc-issue-bot commented 2 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/spaSim to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 years ago

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

nturaga commented 2 years ago

Review 2

Otherwise, it looks good to me. As soon as the build finishes, I'll accept it. Please make the change above.

bioc-issue-bot commented 2 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/spaSim to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

fuerzhou commented 2 years ago

@nturaga Thank you for the update! I have added the ORCID id.

Meanwhile, we are thinking about updating the main data object from SingleCellExperiment to SpatialExperiment as SpatialExperiment is the standard class for spatial data on Bioconductor. The other package that we have submitted, SPIAT, was suggested to do the same update. This will not take long, as SpatialExperiment is an extension of SingleCellExperiment. We would appreciate your comments on this!

lshep commented 2 years ago

SpatialExperiment is probably appropriate modification.

nturaga commented 2 years ago

Hi @fuerzhou

Let me know when you have switched the object class, and i'll take a look again (please issue a new build report).

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 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/spaSim to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

fuerzhou commented 2 years ago

@nturaga We have updated the package and the builds are successful. There are several notes that we could not resolve.

  1. Could not set LazyData to false - if set to false, our external data can not be accessed by the user.
  2. NOTE: Consider multiples of 4 spaces for line indents; 465 lines (13%) are not. I have tried my best to change the indentation generated from Roxygen2, but they can not be changed manually.
  3. NOTE: Consider shorter lines; NOTE: The recommended function length is 50 lines or less. These two notes are related to each other and I have tried to reduce them.
  4. NOTE: Avoid using '=' for assignment and use '<-' instead. - I checked all the files and there shouldn't be any. Do you have any suggestions on how to find out where the issue is?

Please let me know if we should do any further changes. Thank you!

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 years ago

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

bioc-issue-bot commented 2 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/spaSim to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 2 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/spaSim to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

fuerzhou commented 2 years ago

@nturaga We have updated the package and the builds are successful. There are several notes that we could not resolve.

  1. Could not set LazyData to false - if set to false, our external data can not be accessed by the user.
  2. NOTE: Consider multiples of 4 spaces for line indents; 465 lines (13%) are not. I have tried my best to change the indentation generated from Roxygen2, but they can not be changed manually.
  3. NOTE: Consider shorter lines; NOTE: The recommended function length is 50 lines or less. These two notes are related to each other and I have tried to reduce them.
  4. NOTE: Avoid using '=' for assignment and use '<-' instead. - I checked all the files and there shouldn't be any. Do you have any suggestions on how to find out where the issue is?

Please let me know if we should do any further changes. Thank you!

I have deleted the workflow file from the repo.

bioc-issue-bot commented 2 years ago

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.

fuerzhou commented 2 years ago

Thank you @nturaga @vjcitn @lshep for all your help!

lshep commented 2 years ago

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/fuerzhou.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("spaSim"). The package 'landing page' will be created at

https://bioconductor.org/packages/spaSim

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.