fetch_pathofmpred_models: Download user-authorized PathoFMPred model collections

View source: R/object_store.R

fetch_pathofmpred_modelsR Documentation

Download user-authorized PathoFMPred model collections

Description

The source package contains no fitted models. For 'ProvGigaPath', the default is a versioned GitHub release asset whose SHA-256 digest is pinned in the package. It is downloaded only when this function is called. Other representations require an explicit authorized URL and SHA-256 digest. TITAN-derived objects are not downloadable through this helper.

Usage

fetch_pathofmpred_models(
  foundation_model = "ProvGigaPath",
  destination = NULL,
  base_url = NULL,
  expected_sha256 = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

Arguments

foundation_model

'ProvGigaPath' or 'GigaSSL'.

destination

Explicit directory in which model collections will be stored. No directory is created unless the function is called with this argument.

base_url

Optional HTTPS release directory, or a 'file://' URL for an authorized local mirror. The pinned Prov-GigaPath release is the default when this is omitted.

expected_sha256

Optional named character vector containing a 64-character SHA-256 digest for every requested representation. The pinned Prov-GigaPath digest is the default for its release.

overwrite

Replace an existing file.

quiet

Passed to [utils::download.file()].

Value

Named paths to the downloaded model collections.


PathoFMPred documentation built on Nov. 12, 2026, 5:10 p.m.