Skip to content

Commit

Permalink
Add troubleshooting for missing system requirement
Browse files Browse the repository at this point in the history
Documenting the procedure followed at:

- Bioconductor/BBS#220
  • Loading branch information
zeehio committed Oct 18, 2022
1 parent fc66e65 commit d7b1d97
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions troubleshoot-build-report.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,27 @@ SNPchip and GenomeGraphs. A full list of deprecated packages can be found
[List of Deprecated Packages 3.10](https://support.bioconductor.org/p/125352/).
We also documented removed packages on our [Removed Package Page](https://bioconductor.org/about/removed-packages/)

#### System Requirement missing in the Bioconductor Build System

Your package may fail to build or check in the Bioconductor Build System (BBS)
because your package or some of its dependencies have a *System Requirement* not
available in the BBS.

For instance, the first Bioconductor package that suggested the installation of
the [`archive`](https://cran.r-project.org/web/packages/archive/index.html)
CRAN package, could not pass the checks at the BBS. The build report stated that
"the archive package could not be found", however the package had been present
in CRAN for months. The `archive` package reports among its system requirements
the `libarchive` library, and the BBS did not have that library installed.

If you happen to miss a system dependency in the BBS, please open an issue similar
to [BBS issue #220](https://github.com/Bioconductor/BBS/issues/220), where you
mention which is the Bioconductor package that either directly or indirectly
has a system requirement, and if possible provide information on the missing
package that would need to be installed. If you follow the pull requests related
to that issue, you will see that the solution was the installation of the
`libarchive-dev` package, both in the BBS and in the Bioconductor docker images.

### Deprecated Functions {#depFun311}

Functions can be deprecated, defunct, and eventually removed. Bioconductor tries
Expand Down

0 comments on commit d7b1d97

Please sign in to comment.