/rcdk/man/atomcontainer.Rd

http://github.com/rajarshi/cdkr · Unknown · 70 lines · 59 code · 11 blank · 0 comment · 0 complexity · 413484ece5549cf5f2d800555689d920 MD5 · raw file

  1. \name{Molecule}
  2. \alias{get.exact.mass}
  3. \alias{get.natural.mass}
  4. \alias{is.neutral}
  5. \alias{convert.implicit.to.explicit}
  6. \title{
  7. Operations on molecules
  8. }
  9. \description{
  10. Various functions to perform operations on molecules.
  11. \code{get.exact.mass} returns the exact mass of a molecule
  12. \code{get.natural.mass} returns the natural exact mass of a molecule
  13. \code{convert.implicit.explicit} converts implicit hydrogens
  14. to explicit hydrogens. This function does not return any value
  15. but rather modifies the molecule object passed to it
  16. \code{is.neutral} returns \code{TRUE} if all atoms in the molecule
  17. have a formal charge of 0, otherwise \code{FALSE}
  18. }
  19. \usage{
  20. get.exact.mass(molecule)
  21. get.natural.mass(molecule)
  22. convert.implicit.to.explicit(molecule)
  23. is.neutral(molecule)
  24. }
  25. \arguments{
  26. \item{molecule}{A \code{jObjRef} representing an IAtomContainer or IMolecule object}
  27. }
  28. \value{
  29. \code{exact.mass} returns a numeric
  30. \code{get.natural.mass} returns a numeric
  31. \code{convert.implicit.to.explicit} has no return value
  32. \code{is.neutral} returns a boolean.
  33. }
  34. \details{
  35. In some cases, a molecule may not have any hydrogens (such as when read
  36. in from an MDL MOL file that did not have hydrogens). In such cases,
  37. \code{\link{convert.implicit.to.explicit}}
  38. will add implicit hydrogens and then convert them to explicit ones. In addition, for
  39. such cases, make sure that the molecule has been typed beforehand.
  40. }
  41. \keyword{programming}
  42. \seealso{
  43. \code{\link{get.atoms}}, \code{\link{do.typing}}
  44. }
  45. \examples{
  46. m <- parse.smiles('c1ccccc1')[[1]]
  47. ## Need to configure the molecule
  48. do.aromaticity(m)
  49. do.typing(m)
  50. do.isotopes(m)
  51. get.exact.mass(m)
  52. get.natural.mass(m)
  53. convert.implicit.to.explicit(m)
  54. get.natural.mass(m)
  55. do.isotopes(m) # Configure isotopes of newly added hydrogens
  56. get.exact.mass(m)
  57. is.neutral(m)
  58. }
  59. \author{Rajarshi Guha (\email{rajarshi.guha@gmail.com})}