format: Format and Print Coords or Waypoints

In Waypoint: Convert, Validate, Format and Print Geographic Coordinates and Waypoints

Format and Print Coords or Waypoints

Description

Format and print objects of class "coords" or "waypoints".

Usage

## S3 method for class 'coords'
print(x, ..., max = NULL)

## S3 method for class 'waypoints'
print(x, ..., max = NULL)

## S3 method for class 'coords'
format(x, ..., usenames = TRUE)

## S3 method for class 'waypoints'
format(x, ..., usenames = TRUE)

ll_headers(aswidth, fmt)

Arguments

x	object of class "coords" created by function as_coords(), or class "waypoints" created by function as_waypoints().
...	further arguments passed to or from other methods.
max	numeric or NULL, specifying the maximal number of entries to be printed. By default, when NULL, getOption("max.print") used.
usenames	logical, whether or not to include names in formatted output; default TRUE.
aswidth	character vector, used to match width of headers to formatted output.
fmt	integer, 1L, 2L or 3L, specifying the required coordinate format.

Details

The format() methods for "coords" and "waypoints" objects output elegantly formatted character vector representations of their arguments, which are used by their respective print() methods.

Prior to formatting and printing, "coords" or "waypoints" objects are checked to ensure that their "valid" attribute (in the case of a "coords" object), or "validlat" and "validlon" attributes (in the case of a "waypoints" object) are present and all TRUE i.e., valid. If these attributes are found to contain any FALSE i.e. invalid values, a warning is issued and similarly, if these attributes are missing, a warning is issued and the objects are re-validated as described under validate().

ll_headers() outputs the headings ⁠"Latitude ... Longitude"⁠ formatted to the same width as argument aswidth, adjusted for format fmt and is primarily intended for use by the print() method for class "waypoints".

Value

The format() methods for both classes "coords" and "waypoints" return a character vector, respectively of length length(x) or nrow(x), and containing values formatted in decimal degrees, degrees and minutes, or degrees, minutes and seconds as appropriate.

See Also

format(), print(), "coords" and "waypoints".

Examples

## Continuing example from `as_coords()`...


## Print named "coords" object in degrees and minutes,
## 'silently' using S3 print() method
dm

## Print explicitly using S3 print() method, specifying
## the maximal number of entries to be printed
print(dm, max = 14)

## Format as a fixed-width character vector,
## with names...
format(dm)

## ...or without them
format(dm, usenames = FALSE)

###
## Continuing example from `as_waypoints()`...


## Print named "waypoints" object in degrees and minutes,
## 'silently' using S3 print() method
wp

## Print explicitly using S3 print() method, specifying
## the maximal number of entries to be printed
print(wp, max = 21)

## Format as a fixed-width character vector,
## with names...
format(wp)

## ...or without them
format(wp, usenames = FALSE)

rm(dm, wp)

Waypoint documentation built on April 11, 2025, 6:12 p.m.