File: get.total.hydrogen.count.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 (26 lines) | stat: -rwxr-xr-x 823 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rcdk.R
\name{get.total.hydrogen.count}
\alias{get.total.hydrogen.count}
\title{Get total number of implicit hydrogens in the molecule.}
\usage{
get.total.hydrogen.count(mol)
}
\arguments{
\item{mol}{The molecule to query. Should be a `jobjRef` representing an `IAtomContainer`}
}
\value{
An integer representing the total number of implicit hydrogens
}
\description{
Counts the number of hydrogens on the provided molecule. As this method 
will sum all implicit hydrogens on each atom it is important to ensure 
the molecule has already been configured (and thus each atom has an 
implicit hydrogen count).
}
\seealso{
\code{\link{get.hydrogen.count}}, \code{\link{remove.hydrogens}}
}
\author{
Rajarshi Guha (\email{rajarshi.guha@gmail.com})
}