plot3D: plot3D

Description Usage Arguments Details Value

View source: R/plotProtein3D.R

Description

plot the protein structure in 3D

Usage

1
2
3
4
5
6
7
8
9
plot3D(
  protein,
  animated = FALSE,
  type = "p",
  groups = NULL,
  screen = list(x = -60, z = 0, y = 0),
  image_width = 480,
  image_height = 480
)

Arguments

protein

Protein object to be plotted. Can be either of S3 or S4 Protien object type.

animated

logical indicating whether the object is to be animated in the viewer. Will spin the plot on the Z axis.

type

character vector indicating the type of cloud plot. Can include one or more of "p", "l", "h", or "b". "p" and "l" mean points and lines respectively, and "b" means both. "h" stands for histogram and draws lines from each point to the XY plane, either lower or upper bounding box face, whichever is closer.

groups

the name of a column from the Atomic Record of the protein. Causes the points to be colored by the different values in that group.

screen

A list determining the sequence of rotations to be applied to the data before plotting. Each componenet of the list should be one of "x", "y" or "z", repetitions are allowed with values indicating amount of rotation in degrees.

image_width

width of the resulting image in pixels. Currently only applies when 'animated = TRUE'. Defaults to 480 pixels.

image_height

hieght of the resulting image in pixels. Currently only applies when 'animated = TRUE'. Defaults to 480 pixels.

Details

This function uses lattice and magick to create the 3D plot and animate it.

Currently this function is incomplete and will change dramatically as new features and documentation are added.

Value

An object to be plotted. If not assigned to a variable, it will plot directly in the viewer.


protein8k documentation built on Aug. 16, 2021, 9:06 a.m.