evaluate of the canvas size and padding

autoSize {MSImaging}

R Documentation

evaluate of the canvas size and padding

Description

Usage

autoSize(dims, padding,
    scale = 1,
    is.multiple.combine.wide = FALSE,
    ratio.threshold = 1.25,
    ratio.scale = 1.5);

Arguments

dims

the dimension data of the MSImaging raw data. it should be a numeric vector with at least two element standards for [w, h]; or a list object with at least two slot elements which are named w and h.

scale

a numeric factor for describ the pixel scale size in MSImaging rendering process. default value is 1 means no scale, just rendering of the origina size!

padding

the padding element is a numeric vector with four elements standards for css padding value: [top, right, bottom, left].

is.multiple.combine.wide

the function will trying to make the aspect ratio equals to 1:1 if this parameter value is set to false by default.

ratio.scale

the scale of the ratio value should not be 1, due to the reason of 1 means no changes.

Authors

xieguigang

Value

this function returns a list object that contains the recommended size value for the MSImaging plot. the result value contains two slot elements: size element is a dimension vector with two elements standards for [w, h].

[Package MSImaging version 0.1.0 Index]