File: get.bond.order.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 (30 lines) | stat: -rwxr-xr-x 740 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
30
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bonds.R
\name{get.bond.order}
\alias{get.bond.order}
\title{Get an object representing bond order}
\usage{
get.bond.order(order = "single")
}
\arguments{
\item{order}{A character vector that can be one of single, double, triple,
quadruple, quintuple, sextuple or unset. Case is ignored}
}
\value{
A \code{jObjRef} representing an `Order` enum object
}
\description{
This function returns a Java enum representing a
bond order. This can be used to modify the order
of pre-existing bonds
}
\examples{
\dontrun{
m <- parse.smiles('CCN')[[1]]
b <- get.bonds(m)[[1]]
b$setOrder(get.bond.order("double"))
}
}
\author{
Rajarshi Guha (\email{rajarshi.guha@gmail.com})
}