-
Notifications
You must be signed in to change notification settings - Fork 33
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
assorthead #3494
Comments
Hi @LTLA Thanks for submitting your package. We are taking a quick The DESCRIPTION file for this package is:
|
Could we just rubberstamp this through? There's basically no R code here, I'm just centralizing all the header files that are currently scattered throughout beachmat, BiocNeighbors, etc. |
Thanks Aaron -- this is going in a new direction for us so give us a couple of days more. I've been trying to raise awareness in core and TAB about the C++ "substrate" for key analytical processes that you've been working on. Theoretically any developer in the project should have some sense of how to understand and interact with or critique or enhance any key software components. I am putting myself in this position, so will try to work with the tatami gallery. Building it requires an upgrade to my Cmake installation (fine) but then I see that the default installation of tatami will write to /usr/local. I am ok with that but it would be nice for the installation narrative to indicate that. More later. |
Apropos "rubber stamp" I don't think I want to accept that notion. A CMD check shows |
I am not trying to make work here. I think this is a transition for the Bioconductor project. We are doing a lot of internal work to modernize, take advantage of github action concepts, and to embrace a richer set of software concepts and tools. But we can't lose sight of coherence that Bioconductor brings to a very dynamic system of approaches. |
Just to be clear - there is no need for package developers, end-users, or the BBS itself to interact with CMake. (At least, not for this package.) assorthead vendors header-only C++ libraries, meaning that knncolle/BiocNeighbors#25 provides a fairly sophisticated example of how to use these libraries. R users probably won't even notice the difference as everything works as normal. However, package developers now have the opportunity to accept a pointer to a Also the |
Quick question: why include things that are already provided by other C++ header-only packages like RcppAnnoy, RcppEigen, RcppHNSW, etc...? |
Version stability and control over the update cadence. RcppAnnoy is a good example - a few years ago, it updated in the middle of a BioC release cycle, causing the release BiocNeighbors package (which was RcppEigen is another good example - it took over 2 years to update to Eigen 3.4 (see the entire saga at RcppCore/RcppEigen#103), simply because of the inertia of the CRAN packages that were depending on an older version. By vendoring it ourselves, we can hopefully have more regular updates by coercing or cajoling Bioconductor packages to always use the latest version before each release. |
Yes, I think I like the consolidation of this header family for Bioconductor. Understood that users and BBS are insulated from direct involvement but before we adopt I would like the core to have broader acquaintance with the approach. |
To be a little more concrete about the QA enhancements noted above, thanks to a hint from @almahmoud the following
gives us a table of times and outcomes for unit tests in tatami. This might be the basis of an R-based unit test in assorthead to verify that all its C++ friends are succeeding at their GHA tests. Just a thought. |
I think code like the above would iterate over data in inst/manifest.csv to find action outcomes and report on them. |
Note that the GitHub workflow runs operate on the I suppose we could set up a schedule to routinely run checks across the tagged versions, but this is a bit annoying to do on GitHub as they automatically disable scheduled runs when the repository has no activity. If we wanted to do this, we would configure a mega CMake project that pulls in all libraries, builds all the test binaries from every individual project, and checks them all together. This takes advantage of TBH that seems like more work than is warranted. We could just let the other packages depending on assorthead to serve as de facto tests; if there's a breaking change, it should show up pretty quickly as downstream build failures. |
Yes, I get the point about the de facto tests. I'd like us to be sure that a) the breaking change does show up and b) we don't have to do substantial forensics to learn about where the error is. Since we are in devel maybe some experiments can be done. @lshep I think we can start the review for assorthead. |
Your package has been added to git.bioconductor.org to continue the IMPORTANT: Please read this documentation for setting Bioconductor utilized your github ssh-keys for git.bioconductor.org |
Dear Package contributor, This is the automated single package builder at bioconductor.org. Your package has been built on the Bioconductor Single Package Builder. On one or more platforms, the build results were: "WARNINGS". Please see the build report for more details. The following are build products from R CMD build on the Single Package Builder: Links above active for 21 days. Remember: if you submitted your package after July 7th, 2020, |
A reviewer has been assigned to your package for an indepth review. |
Received a valid push on git.bioconductor.org; starting a build for commit id: 20950a411b631b5dc09405f63aade4a34404e52e |
Dear Package contributor, This is the automated single package builder at bioconductor.org. Your package has been built on the Bioconductor Single Package Builder. On one or more platforms, the build results were: "WARNINGS". Please see the build report for more details. The following are build products from R CMD build on the Single Package Builder: Links above active for 21 days. Remember: if you submitted your package after July 7th, 2020, |
Received a valid push on git.bioconductor.org; starting a build for commit id: 18bd9fb5f67bb1792afc2f0f02d5501819412184 |
Dear Package contributor, This is the automated single package builder at bioconductor.org. Your package has been built on the Bioconductor Single Package Builder. On one or more platforms, the build results were: "WARNINGS". Please see the build report for more details. The following are build products from R CMD build on the Single Package Builder: Links above active for 21 days. Remember: if you submitted your package after July 7th, 2020, |
Received a valid push on git.bioconductor.org; starting a build for commit id: c3ae95dd5c919cb7a7cf8f4d153b750117b5011b |
Dear Package contributor, This is the automated single package builder at bioconductor.org. Your package has been built on the Bioconductor Single Package Builder. Congratulations! The package built without errors or warnings Please see the build report for more details. The following are build products from R CMD build on the Single Package Builder: Links above active for 21 days. Remember: if you submitted your package after July 7th, 2020, |
Nudging this. Got a couple of other BioC package updates depending on these headers. |
Hi Aaron, @LTLA |
Your package has been accepted. It will be added to the Thank you for contributing to Bioconductor! Reviewers for Bioconductor packages are volunteers from the Bioconductor |
cannot build unless issue is open and has the |
Did this get added to the build? Usually I see a 3b badge. |
I process packages once or twice a week. the accepted badge is there and with the holiday I did not process accepted packages yet. It should be added in the next day |
The default branch of your GitHub repository has been added to Bioconductor's 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/LTLA.keys is not empty), then no further steps are required. Otherwise, do the following: 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/ 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 https://bioconductor.org/packages/assorthead 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. |
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 Bioconductor Package Naming Policy and acknowledge
Bioconductor may retain use of package name.
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:
months, for bug fixes.
(optionally via GitHub).
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.
The text was updated successfully, but these errors were encountered: