File: get.connected.atom.Rd

package info (click to toggle)
r-cran-rcdk 3.8.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 888 kB
  • sloc: makefile: 14; sh: 13
file content (28 lines) | stat: -rwxr-xr-x 742 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bonds.R
\name{get.connected.atom}
\alias{get.connected.atom}
\title{Get the atom connected to an atom in a bond.}
\usage{
get.connected.atom(bond, atom)
}
\arguments{
\item{bond}{A \code{jObjRef} representing an `IBond` object}

\item{atom}{A \code{jObjRef} representing an `IAtom` object}
}
\value{
A \code{jObjRef} representing an `IAtom`` object
}
\description{
This function returns the atom that is connected to a
specified in a specified bond. Note that this function assumes
2-atom bonds, mainly because the CDK does not currently
support other types of bonds
}
\seealso{
\code{\link{get.atoms}}
}
\author{
Rajarshi Guha (\email{rajarshi.guha@gmail.com})
}