Report timeknit's status for a project

Prints a situation report: whether timeknit is active in this session and knitr's progress display is enabled, which profiles activate it for the project, and which documents in the project are reached when rendered with Quarto. Nothing is changed.

Usage

sitrep(path = ".")

Arguments

path

The project root, or any directory inside it. The root is the nearest directory at or above path containing _quarto.yml, an .Rproj file, DESCRIPTION, or .git, falling back to path itself.

Value

A list with the collected facts, invisibly. The documents element is a data frame with one row per directory holding .qmd or .Rmd files.

Details

A document is counted as covered when the profile R will read for it activates timeknit. Quarto starts R in the document's directory, so that profile is R_PROFILE_USER if set (in this session's environment or in the project's _environment.local or _environment), otherwise a .Rprofile in the document's directory, otherwise ~/.Rprofile.

See also

use_timeknit_project() to set a project up.