R/data.R

#' @title Flake 1
#' @description A demo flake (PGCS_Vau.1) for use with the Lithics3D package.
#' @author Cornel M. Pop
#' @docType data
#' @keywords datasets
#' @name demoFlake1
#' @usage data(demoFlake1)
#' @format A list containing a mesh3d object (mesh) and a set of basic landmarks
#' (lms) defining the ventral surface of the flake
#' @source 3D scan courtesy of Pop Geological Consulting Services
#' LTD <http://www.popgeology.com>
"demoFlake1"

#' @title Flake 2
#' @description A demo flake (PGCS_Vau.2) for use with the Lithics3D package.
#' @author Cornel M. Pop
#' @docType data
#' @keywords datasets
#' @name demoFlake2
#' @usage data(demoFlake2)
#' @format A list containing a mesh3d object (mesh) and a set of basic landmarks
#' (lms) defining the ventral surface of the flake
#' @source 3D scan courtesy of Pop Geological Consulting Services
#' LTD <http://www.popgeology.com>
"demoFlake2"

#' @title Flake 3
#' @description A demo flake (PGCS_RI.1) for use with the Lithics3D package.
#' @author Cornel M. Pop
#' @docType data
#' @keywords datasets
#' @name demoFlake3
#' @usage data(demoFlake3)
#' @format A list containing a mesh3d object (mesh) and a set of basic landmarks
#' (lms) defining the ventral surface of the flake
#' @source 3D scan courtesy of Pop Geological Consulting Services
#' LTD <http://www.popgeology.com>
"demoFlake3"

#' @title Demo sphere
#' @description A small closed sphere used to test functions within this package
#' @docType data
#' @name demoSphere
#' @usage data(demoSphere)
#' @format A mesh3d object
"demoSphere"

#' @title Demo surface
#' @description A small open surface used to test functions within this package
#' @docType data
#' @name demoSurface
#' @usage data(demoSurface)
#' @format A mesh3d object
"demoSurface"
cornelmpop/Lithics3D documentation built on Feb. 10, 2024, 11:54 p.m.