@eagleoutice/flowr - v2.17.4
    Preparing search index...

    Class OnDemandRecoverer

    Recovers packages no signature database knows from their sources: asks each OnDemandSource in turn for archives, reads DESCRIPTION, NAMESPACE, and R/ from the first one that holds the package, and caches the result (or that no source had it) as one JSON file per package, so later analyses need no network.

    Index
    constructor
    cached recover

    • Parameters

      • options: {
            bioconductorMirror?: string;
            bioconductorRelease?: string;
            cacheDir?: string;
            cranMirror?: string;
            enabled: boolean;
            githubMirrors?: boolean;
            maxArchiveMb?: number;
            maxPackages?: number;
            offline?: boolean;
            packages?: string[];
            repositories?: Record<string, string>;
            retryAfterHours?: number;
            sources?: string[];
        }
        • Optional ReadonlybioconductorMirror?: string

          the Bioconductor host (default https://bioconductor.org)

        • Optional ReadonlybioconductorRelease?: string

          the Bioconductor release to fetch from (default release)

        • Optional ReadonlycacheDir?: string

          where to cache what was fetched (default the on-demand directory of the signature cache)

        • Optional ReadonlycranMirror?: string

          the CRAN src/contrib/ to fetch from (default https://cloud.r-project.org/src/contrib/)

        • Readonlyenabled: boolean
        • Optional ReadonlygithubMirrors?: boolean

          whether to use the GitHub mirrors of CRAN and Bioconductor (cran/<pkg>, bioc/<pkg>, default true)

        • Optional ReadonlymaxArchiveMb?: number

          the most MiB a package archive may have (default 32), it may unpack to three times that

        • Optional ReadonlymaxPackages?: number

          the most packages to fetch for one analysis (default 25)

        • Optional Readonlyoffline?: boolean

          only use what was fetched before, never the network (default false)

        • Optional Readonlypackages?: string[]

          only recover packages whose name matches one of these regular expressions, empty means any

        • Optional Readonlyrepositories?: Record<string, string>

          GitHub repositories (owner/repo[/subdir][@ref]) to fetch packages from, by package name

        • Optional ReadonlyretryAfterHours?: number

          how many hours to wait before asking again for a package no source had (default 24)

        • Optional Readonlysources?: string[]

          where to look, in order (default github, cran, bioconductor), a plugin may add sources of its own

      • args: OnDemandRecovererArgs

      Returns OnDemandRecoverer

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods