Bioconductor / Contributions

Contribute Packages to Bioconductor
135 stars 33 forks source link

distSTRING #2385

Closed kullrich closed 2 years ago

kullrich commented 3 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 3 years ago

Hi @kullrich

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: distSTRING
Type: Package
Title: distSTRING calculates pairwise distances between all sequences of a
    DNAStringSet or a AAStringSet using a custom score matrix and conducts
    codon based analysis
Version: 0.99.0
Authors@R: 
    person(given = "Kristian K",
 family = "Ullrich",
 role = c("aut", "cre"),
 email = "ullrich@evolbio.mpg.de",
 comment = c(ORCID = "0000-0003-4308-9626"))
Description: distSTRING calculates pairwise distances between all sequences of
    a DNAStringSet or a AAStringSet using a custom score matrix and conducts
    codon based analysis. It uses scoring matrices to be used in these pairwise
    distance calcualtions which can be adapted to any scoring for DNA or AA
    characters. E.g. by using literal distances distSTRING calcualtes pairwise
    IUPAC distances.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: false
biocViews: Alignment, Sequencing, Genetics, GO
Depends:
  R (>= 4.1.0)
Imports:
  Rcpp,
  RcppThread,
  Biostrings,
  ape,
  doParallel,
  dplyr,
  foreach,
  methods,
  parallel,
  rlang,
  seqinr,
  stringr,
  tibble,
  tidyr,
  stats,
  stringi
Suggests:
  rmarkdown,
  knitr,
  devtools,
  testthat
LinkingTo: Rcpp, RcppThread
VignetteBuilder: knitr
NeedsCompilation: yes
SystemRequirements: C++11
URL: https://gitlab.gwdg.de/mpievolbio-it/diststring, https://mpievolbio-it.pages.gwdg.de/diststring/
BugReports: https://gitlab.gwdg.de/mpievolbio-it/diststring/issues
RoxygenNote: 7.1.2
bioc-issue-bot commented 3 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 3 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/distSTRING to trigger a new build. A quick tutorial for setting up remotes and pushing to upstream can be found here.

bioc-issue-bot commented 3 years ago

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

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

nturaga commented 3 years ago

Hi,

I will review your package post-release i.e after Oct 27th. http://bioconductor.org/developers/release-schedule/

Best,

Nitesh

kullrich commented 3 years ago

@nturaga Hi, I am looking forward to the review process. Is it still possible to add some new functions by taking care of increasing the version number? There are still some statistics based on the calculated distances that I would like to contribute and add to my package?

nturaga commented 3 years ago

Yes, go for it.

Nitesh Turaga Scientist II, Department of Data Science, Bioconductor Core Team Member Dana Farber Cancer Institute

On Oct 16, 2021, at 12:12 AM, Kristian Ullrich @.***> wrote:

@nturaga Hi, I am looking forward to the review process. Is it still possible to add some new functions by taking care of increasing the version number? There are still some statistics based on the calculated distances that I would like to contribute and add to my package?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe. Triage notifications on the go with GitHub Mobile for iOS or Android.

bioc-issue-bot commented 2 years ago

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

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

The package name distSTRING is very close to the CRAN package name stringdist. It would be worth renaming the package to distinguish it a little bit more to avoid confusion.

DESCRIPTION

ok

NAMESPACE

ok

NEWS

ok

R

data

ok

man

ok

tests

Good!

vignettes

ok

kullrich commented 2 years ago

Dear @nturaga, if I rename the package, do I need to resubmit the whole package from scratch?

nturaga commented 2 years ago

I think the easiest would be to resubmit from scratch, but the review I gave you should hold.

I will take over the review of the package under the new name and make sure it gets through. (of course, the build report should be as clean as possible).

Please tag me in a comment when you submit new.

nturaga commented 2 years ago

Please close this issue when you are ready with a new name.

kullrich commented 2 years ago

Dear @nturaga,

regarding the slot access, the '@' are only used in the example section, since many users use them in their code for quick access. And even these lines are only given as comments '#'.

The question would be if I really need to remove them in the example sections, which should help the users to execute the functions?

e.g. addmask2string

Examples
data(iupac, package="distSTRING")
iupac.aa <- iupac |> cds2aa(shorten = TRUE)
## create mask
mask1 <- IRanges::IRanges(start=c(1,41), end=c(20,50))
## add mask
iupac.aa <- iupac.aa |> addmask2string(mask=mask1)
#iupac.aa@metadata$mask
(iupac.aa |> slot("metadata"))$mask
## append mask
mask2 <- IRanges::IRanges(start=c(21), end=c(30))
iupac.aa <- iupac.aa |> addmask2string(mask=mask2)
(iupac.aa |> slot("metadata"))$mask
## overwrite mask
iupac.aa <- iupac.aa |> addmask2string(mask=mask2, append=FALSE)
(iupac.aa |> slot("metadata"))$mask
## reduce by mask
#iupac.aa.region <- iupac.aa |> string2region(mask=iupac.aa@metadata$mask)
iupac.aa.region <- iupac.aa |> string2region(mask=
    (iupac.aa |> slot("metadata"))$mask)
iupac.aa.region |> slot("metadata")
kullrich commented 2 years ago

Dear @nturaga, would be MSA2dist fine for a name 'MultipleSequenceAlignment >>> distance', or still too close to stringdist? Thank you in anticipation Best regards Kristian

nturaga commented 2 years ago

MSA2dist sounds fine to me. Please check the names on Bioconductor and CRAN as well http://contributions.bioconductor.org/package-name.html.

Regarding slot access as an example, if you are not doing it in your code, it's not something your users should be doing either IMO. Accessing a slot is easy if you write accessor functions with good function names.

Example, rse1 is a RangedSummarizedExperiment, but to access the slot, we tell users to use assay(rse1) instead of rse1@assays.

> rse1
class: RangedSummarizedExperiment
dim: 200 6
metadata(0):
assays(1): counts
rownames: NULL
rowData names(1): feature_id
colnames(6): A B ... E F
colData names(1): Treatment
kullrich commented 2 years ago

Dear @nturaga, since the slot access is on a Biostrings::DNAStringSetor an Biostrings::AAStringSetI guess I would need to care about original methods for these classes, right?

kullrich commented 2 years ago

Or even on a XStringSetas given in the description:

Description:

     The BStringSet class is a container for storing a set of ‘BString’
     objects and for making its manipulation easy and efficient.

     Similarly, the DNAStringSet (or RNAStringSet, or AAStringSet)
     class is a container for storing a set of ‘DNAString’ (or
     ‘RNAString’, or ‘AAString’) objects.

     All those containers derive directly (and with no additional
     slots) from the XStringSet virtual class
nturaga commented 2 years ago

I'm not sure I understand your question here.

Even within Biostrings, there are accessor functions to access data within the object. You do not need to alter the original methods in any way.

kullrich commented 2 years ago

Actual, I was just confused by this sentence:

A Collates: field in the DESCRIPTION file may be necessary to order class and method definitions appropriately during package installation.

nturaga commented 2 years ago

Closing this in favor of the other package.