Bioconductor / Contributions

Contribute Packages to Bioconductor
133 stars 33 forks source link

GenomAutomorphism #2678

Closed genomaths closed 2 years ago

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

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: GenomAutomorphism
Title: Compute the automorphisms between DNA's Abelian group representations 
Version: 0.99.0
Authors@R: 
    person( given = "Robersy",
  family = "Sanchez",
  role = c("aut", "cre"),
  email = "genomicmath@gmail.com",
  comment = c(ORCID = "0000-0002-5246-1453"))
URL: https://github.com/genomaths/GenomAutomorphism
BugReports: https://github.com/genomaths/GenomAutomorphism/issues
Description: 
  This is a R package to compute the autimorphisms between pairwise 
  aligned DNA sequences represented as elements from a Genomic 
  Abelian group. In a general scenario, from genomic regions till 
  the whole genomes from a given population (from any species or 
  close related species) can be algebraically represented as a 
  direct sum of cyclic groups or more specifically Abelian p-groups. 
  Basically, we propose the representation of multiple sequence 
  alignments of length N bp as element of a finite Abelian group 
  created by the direct sum of homocyclic Abelian group of 
  prime-power order.
Depends: 
    R (>= 4.2)
License: Artistic-2.0
Encoding: UTF-8
biocViews: 
    MathematicalBiology,
    ComparativeGenomics,
    FunctionalGenomics,
    MultipleSequenceAlignment
Imports:
    Biostrings,
    BiocGenerics,
    BiocParallel,
    GenomeInfoDb,
    GenomicRanges,
    IRanges,
    dplyr,
    data.table,
    parallel,
    doParallel,
    foreach,
    methods,
    S4Vectors,
    stats,
    numbers
RoxygenNote: 7.1.2
Suggests:
    spelling,
    rmarkdown,
    knitr,
    BiocStyle,
    testthat (>= 3.0.0)
VignetteBuilder: knitr
Roxygen: list(markdown = TRUE)
Language: en-US
LazyData: true
Config/testthat/edition: 3
vjcitn commented 2 years ago

Thanks for this contribution. Your vignette has

URL <- paste0("https://github.com/genomaths/seqalignments/raw/master/", 
        "COVID-19/AY390556.1_and_KY417151.1_aligned_protein-coding.fas")

We don't allow dependence of code on data resources lodged in github. You can contribute the data (if large) to ExperimentHub so that there is a systematic way of retrieving and caching the resource. As it stands the data would be read every time the vignette is built. I also find that your vignette does not become available when I build and install your package, via the typical method help.start(). Can you check this? It must have something to do with the VignetteEngine or builder setting....

genomaths commented 2 years ago

Thank you for letting me know

  1. The dependence issue was fixed. The required data was already included in the package in "/data/covid_aln.rda" (I forgot to update the vignette with: data(covid_aln, package = "GenomAutomorphism"), now fixed.

  2. In the file .Rbuildignore, I remove the line with "^vignettes/" and, in the vignette, I introduced the change VignetteEngine{knitr::knitr} -> VignetteEngine{knitr::rmarkdown}. Next, I just follow the suggestions given at https://stackoverflow.com/questions/49476812/error-in-browsevignettes-no-vignettes-found: "When building and reinstalling the package, it appears that sometimes vignettes aren't included unless the install is done from a .tar.gz file".

a. R CMD build GenomAutomorphism.

b. install.packages('~/GenomAutomorphism_0.99.0.tar.gz') : this creates the folder: "/R/x86_64-pc-linux-gnu-library/4.2/GenomAutomorphism/doc" where the vignettes are available for the user. Next, we can just follow the steps: help.start() -> Package -> GenomAutomorphism -> 'package vignettes and other documentation' -> 'GenomAutomorphism::GenomAutomorphism'.

Also, we can get it directly typing: vignette("GenomAutomorphism")

In summary, the installation via install.packages('~/GenomAutomorphism_0.99.0.tar.gz') works for me. However, the installation from inside the Rstudio project fails on building the documentation (on Linux Ubuntu).

Hope these changes are good enough to move forward.

Best regards, Robersy

On Tue, May 31, 2022 at 10:07 AM Vince Carey @.***> wrote:

Thanks for this contribution. Your vignette has

URL <- paste0("https://github.com/genomaths/seqalignments/raw/master/", "COVID-19/AY390556.1_and_KY417151.1_aligned_protein-coding.fas")

We don't allow dependence of code on data resources lodged in github. You can contribute the data (if large) to ExperimentHub so that there is a systematic way of retrieving and caching the resource. As it stands the data would be read every time the vignette is built. I also find that your vignette does not become available when I build and install your package, via the typical method help.start(). Can you check this? It must have something to do with the VignetteEngine or builder setting....

— Reply to this email directly, view it on GitHub https://github.com/Bioconductor/Contributions/issues/2678#issuecomment-1142184330, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEL5XCZ26NORIORV36DMXZTVMYMJBANCNFSM5W22DWOA . You are receiving this because you were mentioned.Message ID: @.***>

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.

On one or more platforms, the build results were: "skipped, TIMEOUT". 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/GenomAutomorphism 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: f3956581a478356341ccebf69084937074e54284

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

lshep commented 2 years ago

sorry for the delay. I'm working on the review and should have it posted in the next day or two.

lshep commented 2 years ago

I'm still working on looking at the R code and class design but in the meantime here are a few easier clean up comments:

General

README

Description

NAMESPACE

inst

vignette

Warning message:
In data(autm_z125, "GenomAutomorphism") :
  data set 'GenomAutomorphism' not found

Will have any further comments shortly.

bioc-issue-bot commented 2 years ago

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

genomaths commented 2 years ago

Dear Ishep Bioconductor/Contributions

I have updated the GitHub repo introducing your suggestions.

The valid push was received on git.bioconductor.orga bout 19h ago but apparently the building step is not moving forward.

Best regards, Robersy

On Thu, Jun 30, 2022 at 10:50 AM lshep @.***> wrote:

I'm still working on looking at the R code and class design but in the meantime here are a few easier clean up comments:

General

  • We encourage pkgdown configuration not to be git tracked or at least not included on the default branch submitted to Bioconductor. okay if you want to leave for now but please consider for the future.

README

-

Areboth .md and .Rmd needed? Having both lends to one being out of date.

BiocManager::install will install both CRAN and Bioconductor packages so there is no need to use install.packages.

Please update installation to show Bioconductor installation (also for the future BiocManager will also install github remotes BiocManager::install('genomaths/GenomAutomorphism')

Description

  • We don't recommend using LazyData: true unless there is a specific use case for it. Please remove if not needed as it can slow installation of the package.

NAMESPACE

  • If you are utilizing class structures (ie. GenomeRanges, BioStrings, etc) than it is often advisable to import the entire package rather than selective import so that the full functionality of the class structure is inheritantly present.

inst

  • Normally we encourage additional data or files included to be in subdirectories inst/extdata and inst/scripts. extdata providing the data files and scripts having a file that includes code, sudo-code, or text describing how the data was generated including relevant source information.

vignette

  • In section 5 and 6 you are missing package= in the data call else there is a warning

Warning message: In data(autm_z125, "GenomAutomorphism") : data set 'GenomAutomorphism' not found

Will have any further comments shortly.

— Reply to this email directly, view it on GitHub https://github.com/Bioconductor/Contributions/issues/2678#issuecomment-1171318918, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEL5XC4L5T76TNZJCDXXDDTVRWX4BANCNFSM5W22DWOA . You are receiving this because you were mentioned.Message ID: @.***>

lshep commented 2 years ago

apologies. It looks like the builder stalled on our end. Im rerunning the report manually and it should post shortly. I will review the changes over the next week or so. Cheers,

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/GenomAutomorphism 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

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.

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

https://bioconductor.org/packages/GenomAutomorphism

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.