adjust_bbox_asp: Get bounding box adjusted to match aspect ratio

View source: R/adjust_bbox_asp.R

adjust_bbox_aspR Documentation

Get bounding box adjusted to match aspect ratio

Description

[Deprecated]

This function is deprecated because the functionality has been incorporated into the improved sfext::st_bbox_asp() function which uses a similar set of parameters.

Get bbox from sf or bbox object adjusted to match an aspect ratio

Takes an area as an sf or bbox object and returns a bounding box that matches the aspect ratio provided to asp and contains the area or bounding box provided. Common aspect ratios include "1:1" (1), "4:6" (0.666), "8.5:11", "16:9" (1.777). The asp parameter supports both numeric values and character strings with ratios matching the format of "width:height".

Usage

adjust_bbox_asp(area = NULL, bbox = NULL, asp = NULL)

Arguments

area

sf object

bbox

bbox object to adjust

asp

Aspect ratio of width to height as a numeric value (e.g. 0.33) or character (e.g. "1:3").

Value

bbox object


elipousson/mapbaltimore documentation built on Nov. 11, 2024, 8:25 p.m.