Framework for Python
R Python CLI

Workflow

scratch_capture()

Write an object to the scratch folder and return it unchanged.

Usage

scratch_capture(
    x: T,
    name: str | None = None,
    to: str | None = None,
    location: str | Path | None = None,
    n: int | None = None,
) -> T

Arguments

Name Type Default Description
x required T

The object. DataFrames are written as TSV by default, anything else as text.
name str | None None

File name. An extension (.txt, .csv, .tsv, .pkl) sets the format. Default: capture_<timestamp>.
to str | None None

"text", "csv", "tsv", or "pickle".
location str | Path | None None

Folder to write to. Default: the scratch folder.
n int | None None

For a DataFrame, write only the first n rows.