dot-adjustLayout: Adjust Layout Parameters for multi* plotting fucntions

.adjustLayoutR Documentation

Adjust Layout Parameters for multi* plotting fucntions

Description

Adjusts layout dimensions and properties based on the specified layout type. Updates the provided environment with new dimensions and layout configuration.

Usage

.adjustLayout(layout, scaling, wA4, hA4, env)

Arguments

layout

A string specifying the layout type. Can be either "tall" or "wide". Default: NULL.

scaling

A numeric scaling factor to adjust the dimensions. Default: 1.

wA4

The width of the A4 paper in inches. Default: 8.27.

hA4

The height of the A4 paper in inches. Default: 11.69.

env

The environment where the layout dimensions and properties should be assigned. Default: parent.frame().

Value

Invisible NULL. The function operates by side effects, updating the env environment.

Examples

env <- new.env()
.adjustLayout("tall", 1, 8.27, 11.69, env)
print(env$w) # Should print the width based on "tall" layout scaling.


vertesy/Seurat.utils documentation built on Dec. 4, 2024, 5:20 p.m.