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

Description Usage Arguments Value See Also Examples

View source: R/makeExamples.R

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

1

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

1
2
3
4
5
6
7
8
## Not run: 
#an example knot
knot <- makeExampleKnot(k = TRUE)

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

## End(Not run)

Rknots documentation built on May 29, 2017, 1:38 p.m.