R/square.R

In sunniraleigh/schoolR: Aids Students And Teachers In Learning And Teaching Data Science

#' graphs and calculates the area and perimeter of a square
#' @param x a numeric vector containing a positive integer
#' @return a dataframe containining the length, width, area, perimeter,
#' and a graph of the square with length and width \code{x}
#' @examples
#' square(3)
#' square (2:4)
#' @import ggplot2
#' @import tibble
#' @export
square <- function(x) {
  #tibble containing information
  math <- tibble::tibble(
    length = x,
    width = x,
    area = x^2,
    perimeter = 4 * x
  )

  # To find the coordinates
  coords <- tibble::tibble(
    x1 = 0,
    x2 = 0 + x,
    y1 = 0,
    y2 = x
  )

  #To draw square
  shape <- ggplot() +
    geom_rect(
      data = coords, aes(xmin = x1, xmax = x2, ymin = y1, ymax = y2,
                         col = math$perimeter, fill = math$area),
      alpha = 0.5
    ) +
    labs(title = "Square Plot", x = "Width", y = "Length", col = "Perimeter",
         fill = "Area") +
    coord_equal()


  #Print table
  print(math)

  #Call Shape
  shape
}