summary.Lines: Return a summary of a 'Lines' 'object'

View source: R/ClassFunctions.R

summary.LinesR Documentation

Return a summary of a Lines object

Description

Returns the below information about the object:

call of the function defining the object, the defining points, selected x and y points on the line, equation of the line, and coefficients of the line.

Usage

## S3 method for class 'Lines'
summary(object, ...)

Arguments

object

An object of class Lines.

...

Additional parameters for summary.

Value

The call of the object of class "Lines", the defining points, selected x and y points on the line, equation of the line, and coefficients of the line (in the form: y = slope * x + intercept).

See Also

print.Lines, print.summary.Lines, and plot.Lines

Examples

A<-c(-1.22,-2.33); B<-c(2.55,3.75)
xr<-range(A,B);
xf<-(xr[2]-xr[1])*.1
#how far to go at the lower and upper ends in the x-coordinate
x<-seq(xr[1]-xf,xr[2]+xf,l=3) #try also l=10, 20 or 100

lnAB<-Line(A,B,x)
lnAB
summary(lnAB)


elvanceyhan/pcds documentation built on June 29, 2023, 8:12 a.m.