PageRenderTime 4ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

/rcdk/man/getproperty.Rd

http://github.com/rajarshi/cdkr
Unknown | 40 lines | 39 code | 1 blank | 0 comment | 0 complexity | d806a901ed11db1bf0593eb7ec664909 MD5 | raw file
  1. \name{get.property}
  2. \alias{get.property}
  3. \alias{get.title}
  4. \title{
  5. Get the Value of a Molecule Property
  6. }
  7. \description{
  8. This function retrieves the value of a keyed property that has
  9. previously been set on the molecule.
  10. The \code{get.title} function is simply a wrapper around
  11. \code{get.property} that directly provides access to the molecule
  12. title.
  13. }
  14. \usage{
  15. get.property(molecule, key)
  16. get.title(molecule)
  17. }
  18. \arguments{
  19. \item{molecule}{A Java object of class \code{IAtomContainer}}
  20. \item{key}{A string naming the property}
  21. }
  22. \value{
  23. The value of the property is the key is found else NA. For
  24. \code{get.title}, the title of the molecule if available otherwise NA
  25. }
  26. \examples{
  27. smiles <- 'c1ccccc1'
  28. mol <- parse.smiles(smiles)[[1]]
  29. set.property(mol, 'prop1', 23.45)
  30. set.property(mol, 'prop2', 'inactive')
  31. get.property(mol, 'prop1')
  32. }
  33. \keyword{programming}
  34. \seealso{
  35. \code{\link{get.properties}},
  36. \code{\link{set.property}},
  37. \code{\link{remove.property}}
  38. }
  39. \author{Rajarshi Guha (\email{rajarshi.guha@gmail.com})}