makeExampleKnot: Randomly select a knot or a link from the local repository

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

Description

This function returns a randomly selected knot or link from the Rolfsen table or from the link repository. It is used for the examples in some of the package help pages and can be used to test the different functions.

Usage

makeExampleKnot(k = TRUE)

Arguments

k	logical, if TRUE a knot is returned, otherwise it returns a link.

Value

A matrix with the 3D coordinates of a knot if k is FALSE. A list with two slots: the 3D coordinates of a link and a vector of separators if k is TRUE.

See Also

Knot-class, newKnot

Examples

## Not run: 
#an example knot
knot <- makeExampleKnot(k = TRUE)

#an example link
link <- makeExampleKnot(k = FALSE)

## End(Not run)

Rknots documentation built on May 1, 2019, 10:19 p.m.