aboutsummaryrefslogblamecommitdiff
path: root/man/pai.Rd
blob: cec3015331c7f78cb122cf56e271be41a38e155c (plain) (tree)
1
2
3
4
5
6
7
8
                                            




                                                                         

                                         


                                                                                  
                                                                            
 
          




                                                   




                            

 
 





                                                       
          
                                                                                                       
 
                                                                                   










































                                                                                                                                                                                                                                
              






                         
 
 

















                                                                                             
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/chent.R
\docType{class}
\name{pai}
\alias{pai}
\title{An R6 class for pesticidal active ingredients and associated data}
\format{
An \code{\link{R6Class}} generator object
}
\description{
The class is initialised with an identifier which is generally an ISO common name.
Additional chemical information is retrieved from the internet if available.
}
\examples{
# On Travis, we get a certificate validation error,
# likely because the system (xenial) is so old,
# therefore don't run this example on Travis
if (Sys.getenv("TRAVIS") == "") {

atr <- pai$new("atrazine")
print(atr)
if (!is.null(atr$Picture)) {
  plot(atr)
}

}
}
\keyword{data}
\section{Super class}{
\code{\link[chents:chent]{chents::chent}} -> \code{pai}
}
\section{Public fields}{
\if{html}{\out{<div class="r6-fields">}}
\describe{
\item{\code{iso}}{ISO common name according to ISO 1750 as retreived from pesticidecompendium.bcpc.org}

\item{\code{bcpc}}{List of information retrieved from pesticidecompendium.bcpc.org}
}
\if{html}{\out{</div>}}
}
\section{Methods}{
\subsection{Public methods}{
\itemize{
\item \href{#method-new}{\code{pai$new()}}
\item \href{#method-clone}{\code{pai$clone()}}
}
}
\if{html}{
\out{<details ><summary>Inherited methods</summary>}
\itemize{
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_PUF">}\href{../../chents/html/chent.html#method-add_PUF}{\code{chents::chent$add_PUF()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_TP">}\href{../../chents/html/chent.html#method-add_TP}{\code{chents::chent$add_TP()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_cwsat">}\href{../../chents/html/chent.html#method-add_cwsat}{\code{chents::chent$add_cwsat()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_p0">}\href{../../chents/html/chent.html#method-add_p0}{\code{chents::chent$add_p0()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_soil_degradation">}\href{../../chents/html/chent.html#method-add_soil_degradation}{\code{chents::chent$add_soil_degradation()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_soil_ff">}\href{../../chents/html/chent.html#method-add_soil_ff}{\code{chents::chent$add_soil_ff()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_soil_sorption">}\href{../../chents/html/chent.html#method-add_soil_sorption}{\code{chents::chent$add_soil_sorption()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_transformation">}\href{../../chents/html/chent.html#method-add_transformation}{\code{chents::chent$add_transformation()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="emf">}\href{../../chents/html/chent.html#method-emf}{\code{chents::chent$emf()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="get_chyaml">}\href{../../chents/html/chent.html#method-get_chyaml}{\code{chents::chent$get_chyaml()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="get_pubchem">}\href{../../chents/html/chent.html#method-get_pubchem}{\code{chents::chent$get_pubchem()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="get_rdkit">}\href{../../chents/html/chent.html#method-get_rdkit}{\code{chents::chent$get_rdkit()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="pdf">}\href{../../chents/html/chent.html#method-pdf}{\code{chents::chent$pdf()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="png">}\href{../../chents/html/chent.html#method-png}{\code{chents::chent$png()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="try_pubchem">}\href{../../chents/html/chent.html#method-try_pubchem}{\code{chents::chent$try_pubchem()}}\out{</span>}
}
\out{</details>}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-new"></a>}}
\if{latex}{\out{\hypertarget{method-new}{}}}
\subsection{Method \code{new()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{pai$new(
  iso,
  identifier = iso,
  smiles = NULL,
  smiles_source = "user",
  inchikey = NULL,
  inchikey_source = "user",
  bcpc = TRUE,
  pubchem = TRUE,
  pubchem_from = "auto",
  rdkit = TRUE,
  template = NULL,
  chyaml = TRUE
)}\if{html}{\out{</div>}}
}

}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-clone"></a>}}
\if{latex}{\out{\hypertarget{method-clone}{}}}
\subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{pai$clone(deep = FALSE)}\if{html}{\out{</div>}}
}

\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{deep}}{Whether to make a deep clone.}
}
\if{html}{\out{</div>}}
}
}
}

Contact - Imprint