prompt_mem: Example prompt that shows the current memory usage of the R...

View source: R/prompt-mem.R

prompt_memR Documentation

Example prompt that shows the current memory usage of the R process

Description

Example prompt that shows the current memory usage of the R process

Usage

prompt_mem(...)

memory_usage()

Arguments

...

Ignored.

Details

prompt_mem() is a simple example prompt that shows the physical memory allocated by the current process.

memory_usage() is a utility function that shows memory information about the current R process and the system. You can use it to create a custom prompt.

Value

prompt_mem() returns the formatted prompt in a string.

memory_usage() returns a list with entries:

  • bytes: the number of bytes of memory the current process uses. This is the 'Resident Set Size', see ps::ps_memory_info().

  • formatted: string that formats bytes nicely, with the appropriate unit.

  • total: Total physical memory. See ps::ps_system_memory().

  • avail: the memory that can be given instantly to processes without the system going into swap. See ps::ps_system_memory().

  • percent: Percentage of memory that is taken. See ps::ps_system_memory().

See Also

Other example prompts: new_prompt_powerline(), prompt_devtools(), prompt_fancy(), prompt_git(), prompt_runtime(), prompt_status()

Examples


cat(prompt_mem())


memory_usage()


prompt documentation built on Aug. 31, 2023, 5:07 p.m.