load_hbond_ts: Loading hydrogen bonds timeseries

Description Usage Arguments Value Author(s) Examples

View source: R/hbond.R

Description

This function loads hydrogen bond timeseries information from a text file and stores it in a table. See function hbond_ts() for usage of the return value. In case, AMBER format is used as input, this functions' return value might also be used for function hbond().

Usage

1
2
load_hbond_ts( path,
               mdEngine = "GROMOS" ) 

Arguments

path

Specifies the path of the input file.

mdEngine

Argument distinguishes between input formats based on the molecular dynamics engine used. Currently available: "GROMOS", "GROMACS" and "AMBER".

Value

Returns a nx2-matrix, where the first column holds the time in snapshots and the second one the respective hydrogen bond identifier. Note, that function hbond_ts() requires additional input provided by function load_hbond() and that hydrogen bond identifiers have to match.

Author(s)

Christian Margreitter

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
# the examples are valid and wrapped in the "dontrun{}" environment for efficiency purposes only
# GROMOS
## Not run: 
load_hbond_ts( system.file( "extdata/hbond_ts_example.txt.gz", package = "MDplot" ) )
## End(Not run)

# GROMACS
## Not run: 
load_hbond_ts( system.file( "extdata/hbond_ts_example_GROMACS.xpm.gz",
                            package = "MDplot" ),
               mdEngine = "GROMACS" )
## End(Not run)

# AMBER
## Not run: 
load_hbond_ts( system.file( "extdata/hbond_ts_example_AMBER.txt.gz",
                            package = "MDplot" ),
               mdEngine = "AMBER" )
## End(Not run)

MDplot documentation built on July 5, 2017, 1:05 a.m.

Related to load_hbond_ts in MDplot...