metadynminer3d v0.0.1

0

Monthly downloads

0th

Percentile

Tools to Read, Analyze and Visualize Metadynamics 3D HILLS Files from 'Plumed'

Metadynamics is a state of the art biomolecular simulation technique. 'Plumed' Tribello, G.A. et al. (2014) <doi:10.1016/j.cpc.2013.09.018> program makes it possible to perform metadynamics using various simulation codes. The results of metadynamics done in 'Plumed' can be analyzed by 'metadynminer'. The package 'metadynminer' reads 1D and 2D metadynamics hills files from 'Plumed' package. As an addendum, 'metadynaminer3d' is used to visualize 3D hills. It uses a fast algorithm by Hosek, P. and Spiwok, V. (2016) <doi:10.1016/j.cpc.2015.08.037> to calculate a free energy surface from hills. Minima can be located and plotted on the free energy surface. Free energy surfaces and minima can be plotted to produce publication quality images.

Readme

Build Status Build Status CRAN status CRAN downloads Rdoc codecov

metadynminer3d

Introduction

metadynminer is R packages for reading, analysis and visualization of metadynamics HILLS files produced by Plumed. It reads HILLS files from Plumed, calculates free energy surface by fast Bias Sum algorithm, finds minima and analyses transition paths by Nudged Elastic Band method.

metadynminer3d is its addendum for plotting 3D free energy surfaces. It uses RGL package. metadynminer3d installs and loads metadynminer automatically.

Usage

# Install from R repository
install.packages("metadynminer3d")

# Install from GitHub by devtools
install.packages("devtools")
devtools::install_github("spiwokv/metadynminer3d")

# Load library
library(metadynminer3d)
# Read hills file
hillsf<-read.hills3d("HILLS", per=c(TRUE, TRUE, TRUE)) # HILLS with periodicity on CV1, CV2 and CV3

# Sum two hills files
hillsf+hillsf

# Summary of a hills file
summary(hillsf)

# Plot CVs
plot(hillsf)

# Plot heights
plotheights(hillsf)

# Calculate FES by bias sum (alternatively use fes2 for conventional calculation)
tfes<-fes(hillsf)

# Calculate FES for given range (indexes of hills)
tfes<-fes(hillsf, imin=5000, imax=10000)

# Sum two FESes
tfes+tfes

# Calculate and subtract min, max or mean from a FES
tfes<-tfes-min(tfes)

# Summary of FES
summary(tfes)

# Plot FES
plot(tfes, level=20)

# Find minima
minima<-fesminima(tfes)

# Summary of minima
summary(minima)

# Plot free energy minima
plot(minima)

# Calculate free energy profile for minima
prof<-feprof(minima)

# Plot free energy profile for minima
plot(prof)

Functions in metadynminer3d

Name Description
fes2.hillsfile3d Calculate 3D free energy surface by conventional algorithm
head.hillsfile3d Print first n lines of hillsfile3d
min.fes3d Calculate minimum of 3D free energy surface
acealanme3d Hills from 30 ns metadynamics of AceAlaNme in water with three collective variable
fesminima.fes3d Find free energy minima in the fes3d object
feprof.minima3d Calculate free energy profile for minima3d object
oneminimum.fes3d Creates one ad hoc 3D free energy minimum for a fes object
max.fes3d Calculate maximum of 3D free energy surface
fes.hillsfile3d Calculate 3D free energy surface by Bias Sum algorithm
plot.fes3d Plot 3D free energy surface object
read.hills3d Read 3D HILLS from Plumed
plot.minima3d Plot minima3d object
plot.hillsfile3d Plot hillsfile3d object
summary.hillsfile3d Print summary for hillsfile3d
tail.hillsfile3d Print last n lines of hillsfile3d
summary.fes3d Print summary of 3D free energy surface
summary.minima3d Print minima3d object summary
plotheights.hillsfile3d Plot evolution of heights of hills in hillsfile3d object
print.fes3d Print minimum and maximum of 3D free energy surface
print.hillsfile3d Print hillsfile3d
print.minima3d Print minima3d object
read.plumed3d Read 3D free energy surface from PLUMED sum_hills
No Results!

Last month downloads

Details

Type Package
Date 2019-07-22
LinkingTo Rcpp
LazyData true
License GPL-3
RoxygenNote 6.1.0
URL http://www.metadynamics.cz/metadynminer3d
NeedsCompilation yes
Packaged 2019-07-26 12:19:52 UTC; spiwokv
Repository CRAN
Date/Publication 2019-07-28 11:10:04 UTC
depends metadynminer , R (>= 3.3.0) , rgl
imports misc3d , Rcpp
suggests testthat
Contributors

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/metadynminer3d)](http://www.rdocumentation.org/packages/metadynminer3d)