File: get.chem.object.builder.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 1,153 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rcdk.R
\name{get.chem.object.builder}
\alias{get.chem.object.builder}
\title{Get the default chemical object builder.}
\usage{
get.chem.object.builder()
}
\value{
An instance of \href{https://cdk.github.io/cdk/2.5/docs/api/org/openscience/cdk/silent/SilentChemObjectBuilder.html}{SilentChemObjectBuilder}
}
\description{
The CDK employs a builder design pattern to construct
instances of new chemical objects (e.g., atoms, bonds, parsers
and so on). Many methods require an instance of a builder 
object to function. While most functions in this package handle
this internally, it is useful to be able to get an instance of
a builder object when directly working with the CDK API via
`rJava`.
}
\details{
This method returns an instance of the \href{https://cdk.github.io/cdk/2.5/docs/api/org/openscience/cdk/silent/SilentChemObjectBuilder.html}{SilentChemObjectBuilder}. 
Note that this is a static object that is created at package load time, 
and the same instance is returned whenever this function is called.
}
\author{
Rajarshi Guha (\email{rajarshi.guha@gmail.com})
}