search

ropensci / smapr

An R package for acquisition and processing of NASA SMAP data
https://docs.ropensci.org/smapr
79 stars 25 forks source link

Mention httr system deps in README #37

Closed mbjoseph closed 6 years ago

mbjoseph commented 6 years ago

@marcosci pointed out that it might be useful to mention the system dependencies for the httr package in the installation instructions (https://github.com/ropensci/onboarding/issues/231). On Debian systems this is libssl-dev and openssl@1.1 via brew for macOS.

mbjoseph commented 6 years ago

Actually - I think it makes more sense not to do this, as these system deps are already well handled by the httr package. If a user tries to install it without the proper system deps, they will get a nice error message, e.g.,

------------------------ ANTICONF ERROR ---------------------------
Configuration failed because openssl was not found. Try installing:
 * deb: libssl-dev (Debian, Ubuntu, etc)
 * rpm: openssl-devel (Fedora, CentOS, RHEL)
 * csw: libssl_dev (Solaris)
 * brew: openssl@1.1 (Mac OSX)
If openssl is already installed, check that 'pkg-config' is in your
PATH and PKG_CONFIG_PATH contains a openssl.pc file. If pkg-config
is unavailable you can set INCLUDE_DIR and LIB_DIR manually via:
R CMD INSTALL --configure-vars='INCLUDE_DIR=... LIB_DIR=...'
--------------------------------------------------------------------
ERROR: configuration failed for package ‘openssl’

So, that should provide a better hint (and one that does not need to be maintained as part of the smapr package) over the long term, consistent with the idea that the R packages smapr depends on are responsible for handling their own system dependencies.