Knot-class: Class "Knot" - a container for knot and link coordinates and...

In FedericoComoglio/Rknots: Topological Analysis of Knotted Proteins, Biopolymers and 3D Structures

Description

This is the main class for the present package.

Objects from the Class

Objects should be created with calls to newKnot.

Note

Note: This is a summary for reference. For a detailed explanation, please see the vignette. The slot points3D contains the 3D coordinates of points of a polygonal knot or link as an N x 3 matrix. The slot ends contains a vector of link separators. This is automatically set to numeric(0) for knots.

See Also

newKnot, makeExampleKnot

Examples

# create an object of class 'Knot' by using new
link <- makeExampleKnot( k = FALSE )
new('Knot', points3D = link$points3D, ends = link$ends)

#or by means of the constructor
newKnot(points3D = link$points3D, ends = link$ends)

#for knots, it is sufficient to specify the 3D coordinates
#ends are set by default to numeric(0)
knot <- makeExampleKnot( k = TRUE )
newKnot(points3D = knot)

#for creating an example, use makeExampleKnot.
#knot: 
makeExampleKnot(k = TRUE)
#link:
makeExampleKnot(k = FALSE)

FedericoComoglio/Rknots documentation built on May 6, 2019, 4:35 p.m.