PageRenderTime 31932ms CodeModel.GetById 81ms RepoModel.GetById 0ms app.codeStats 1ms

/rcdk/man/parsesmiles.Rd

http://github.com/rajarshi/cdkr
Unknown | 48 lines | 47 code | 1 blank | 0 comment | 0 complexity | 92f83b43ac13a2ce41552621870ff48a MD5 | raw file
  1. \name{parse.smiles}
  2. \alias{parse.smiles}
  3. \title{
  4. Parse a Vector of SMILES Strings
  5. }
  6. \description{
  7. This function parses a vector of SMILES strings to generate a list of
  8. \code{IAtomContainer} objects. Note that the resultant molecule will
  9. not have any 2D or 3D coordinates.
  10. Note that the molecules obtained from this method will not have any
  11. aromaticity perception, atom typing or isotopic configuration
  12. done on them. This is in
  13. contrast to the \link{load.molecules} method. Thus, you should
  14. perform these steps manually on the molecules.
  15. }
  16. \usage{
  17. parse.smiles(smiles, kekulise=TRUE)
  18. }
  19. \arguments{
  20. \item{smiles}{A SMILES string}
  21. \item{kekulise}{If set to \code{FALSE} disables electron checking and
  22. allows for parsing of incorrect SMILES. If a SMILES does not parse by default, try
  23. setting this to \code{FALSE} - though the resultant molecule may not have consistent
  24. bonding. As an example, c4ccc2c(cc1=Nc3ncccc3(Cn12))c4 will not be parsed by default
  25. because it is missing a nitrogen. With this argument set to \code{FALSE} it will parse
  26. succesfully, but this is a hack to handle an incorrect SMILES}
  27. }
  28. \examples{
  29. smiles <- c('CCC', 'c1ccccc1', 'C(C)(C=O)C(CCNC)C1CC1C(=O)')
  30. mol <- parse.smiles(smiles[1])
  31. mols <- parse.smiles(smiles)
  32. }
  33. \value{
  34. A list of \code{jobjRef}s to their corresponding CDK \code{IAtomContainer} objects. If a
  35. SMILES string could not be parsed, \code{NA} is returned instead.
  36. }
  37. \keyword{programming}
  38. \seealso{
  39. \code{\link{load.molecules}},
  40. \code{\link{get.smiles}},
  41. \code{\link{get.smiles.parser}},
  42. \code{\link{view.molecule.2d}},
  43. \code{\link{do.aromaticity}},
  44. \code{\link{do.typing}},
  45. \code{\link{do.isotopes}}
  46. }
  47. \author{Rajarshi Guha (\email{rajarshi.guha@gmail.com})}