File: get.atom.index.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 (29 lines) | stat: -rwxr-xr-x 648 bytes parent folder | download | duplicates (2)
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
29
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/atoms.R
\name{get.atom.index}
\alias{get.atom.index}
\title{get.atom.index}
\usage{
get.atom.index(atom, mol)
}
\arguments{
\item{atom}{The atom object}

\item{mol}{The `IAtomContainer` object containing the atom}
}
\value{
An integer representing the atom index.
}
\description{
Get the index of an atom in a molecule.
}
\details{
Acces the index of an atom in the context of an IAtomContainer. 
Indexing starts from 0. If the index is not known, -1 is returned.
}
\seealso{
\code{\link{get.connected.atom}}
}
\author{
Rajarshi Guha (\email{rajarshi.guha@gmail.com})
}