source_ram: Allocate system RAM

In brendan-newlon/sourceR: What the Package Does (One Line, Title Case)

Description

Allocate a portion of system RAM for R and/or Java to use.

Usage

source_ram(
  only_free = T,
  percent_of_total = 20,
  mem_unit = "GiB",
  round_up = T
)

Arguments

only_free	If TRUE, only allocate the system's currently free memory.
percent_of_total	An integer of what percent of memory to allocate, which also serves as an upper limit to allocating free ram.
mem_unit	Currently assumes available memory is measured in GB – More options TBD in a future version.
round_up	If TRUE, it rounds decimals .5 and above up to the next whole number of GBs, otherwise rounds down.

Value

Sets memory use option.

brendan-newlon/sourceR documentation built on Jan. 28, 2022, 10:14 a.m.