read.pdb: read.pdb

Description Usage Arguments Format Details Value

View source: R/read.pdb.R

Description

Read in a Protein Data Bank file

Usage

1
read.pdb(fileName, createAsS4 = TRUE)

Arguments

fileName

character string for location and name of file to be read.

createAsS4

Logical indicating whether to create the new protein object as S4 or not. Defaults to TRUE if not specified. This argument is optional.

Format

A Protein object. List comprised of several sublists and dataframes

Details

Reads a Protein Data Bank file (PDB) from the given location. The function then parses the file and creates a new object of the Protein class. This object can be either defined as an S3 or S4 object if different capabilities are required.

Value

A new protein object as either an S3 or S4 object.

In general terms, the new object will be a list of two, a data frame containing the atomic record, and a list of header elements.


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