/rcdk/man/atomcontainer.Rd
http://github.com/rajarshi/cdkr · Unknown · 70 lines · 59 code · 11 blank · 0 comment · 0 complexity · 413484ece5549cf5f2d800555689d920 MD5 · raw file
- \name{Molecule}
- \alias{get.exact.mass}
- \alias{get.natural.mass}
- \alias{is.neutral}
- \alias{convert.implicit.to.explicit}
- \title{
- Operations on molecules
- }
- \description{
- Various functions to perform operations on molecules.
- \code{get.exact.mass} returns the exact mass of a molecule
- \code{get.natural.mass} returns the natural exact mass of a molecule
- \code{convert.implicit.explicit} converts implicit hydrogens
- to explicit hydrogens. This function does not return any value
- but rather modifies the molecule object passed to it
- \code{is.neutral} returns \code{TRUE} if all atoms in the molecule
- have a formal charge of 0, otherwise \code{FALSE}
- }
- \usage{
- get.exact.mass(molecule)
- get.natural.mass(molecule)
- convert.implicit.to.explicit(molecule)
- is.neutral(molecule)
- }
- \arguments{
- \item{molecule}{A \code{jObjRef} representing an IAtomContainer or IMolecule object}
- }
- \value{
- \code{exact.mass} returns a numeric
- \code{get.natural.mass} returns a numeric
- \code{convert.implicit.to.explicit} has no return value
- \code{is.neutral} returns a boolean.
- }
- \details{
- In some cases, a molecule may not have any hydrogens (such as when read
- in from an MDL MOL file that did not have hydrogens). In such cases,
- \code{\link{convert.implicit.to.explicit}}
- will add implicit hydrogens and then convert them to explicit ones. In addition, for
- such cases, make sure that the molecule has been typed beforehand.
- }
- \keyword{programming}
- \seealso{
- \code{\link{get.atoms}}, \code{\link{do.typing}}
- }
- \examples{
- m <- parse.smiles('c1ccccc1')[[1]]
- ## Need to configure the molecule
- do.aromaticity(m)
- do.typing(m)
- do.isotopes(m)
- get.exact.mass(m)
- get.natural.mass(m)
- convert.implicit.to.explicit(m)
- get.natural.mass(m)
- do.isotopes(m) # Configure isotopes of newly added hydrogens
- get.exact.mass(m)
- is.neutral(m)
- }
- \author{Rajarshi Guha (\email{rajarshi.guha@gmail.com})}