Skip to contents

Download the photon executable from GitHub.

Usage

download_photon(
  path = ".",
  version = NULL,
  opensearch = FALSE,
  only_url = FALSE,
  quiet = FALSE
)

Arguments

path

Path to a directory to store the executable.

version

Version tag of the photon release. If NULL, downloads the latest known version. A list of all releases can be found here: https://github.com/komoot/photon/releases/. Ignored if jar is given. If NULL, uses the latest known version (Currently: 0.6.2).

opensearch

If TRUE, downloads the OpenSearch version of photon if available. OpenSearch versions are available for photon >= 0.6.0.

only_url

If TRUE, performs a download. Otherwise, only returns a link to the file.

quiet

If TRUE, suppresses all informative messages.

Value

If only_url = FALSE, returns a character string giving the path to the downloaded file. Otherwise, returns the URL to be downloaded.

Examples

download_photon(tempdir(), version = "0.4.1")
#>  Fetching photon 0.4.1.
#>  Successfully downloaded photon 0.4.1. [1s]
#> 
#> [1] "/tmp/RtmpoQ9kXH/photon-0.4.1.jar"