Version status of every hvtiR member

Compares each member installed locally against the version and, when pak recorded its GitHub commit, the commit on the main branch of its repository. The returned table remains version-focused; commit provenance is an internal tie-breaker when versions match.

Usage

status(remote = TRUE)

Arguments

remote: Consult GitHub for the latest versions? When FALSE, no network request is made, latest is NA throughout, and installed members report "ok-local".

Value

A data frame of class hvtiR_status, one row per member, with character columns:

package: The package name.
repo: The GitHub repository it installs from.
installed: Installed version, or NA if not installed.
latest: Version on GitHub main, or NA.
status: One of "ok", "stale", "missing", "ahead", "unknown" or "ok-local". A member is also "stale" when its version matches main but its recorded GitHub commit does not.

Details

hvtiR itself is checked separately because it is not a family member. It remains outside the returned table, but the printed report says when the installer is behind and names the command that updates it.

The object is returned visibly and has a print method, so a bare call displays the table while st <- status() captures the data frame for scripting.

Examples

# Offline: reports what is installed without contacting GitHub
status(remote = FALSE)
#> hvtiR 1.3.1 - 12 members
#> 
#>   - hvtiRutilities   1.2.1      -          ok-local
#>   x hvtiRdatabuild   -          -          missing
#>   - hvtiRtables      1.0.2      -          ok-local
#>   x hvtiRtemplates   -          -          missing
#>   - hvtiPlotR        2.7.15     -          ok-local
#>   x hvtiRlifetables  -          -          missing
#>   x hvtiRbootstrap   -          -          missing
#>   - hvtiRpropensity  0.1.5      -          ok-local
#>   x hvtiRimputation  -          -          missing
#>   x ggBoostedTrees   -          -          missing
#>   - TemporalHazard   1.2.11     -          ok-local
#>   - ggRandomForests  4.0.0      -          ok-local
#> 
#> ℹ 6 members need updating. Run `hvtiR::update()`.