From bbc70f777b49237649c8e9b84602df486f43ca39 Mon Sep 17 00:00:00 2001 From: Zach Charlop-Powers Date: Sat, 10 Jul 2021 17:09:17 -0400 Subject: [PATCH] update docs. --- rcdk/man/do.aromaticity.Rd | 2 +- rcdk/man/do.isotopes.Rd | 2 +- rcdk/man/get.desc.categories.Rd | 2 +- rcdk/man/get.volume.Rd | 2 +- rcdk/man/view.table.Rd | 18 ++++++++++++++++++ 5 files changed, 22 insertions(+), 4 deletions(-) create mode 100644 rcdk/man/view.table.Rd diff --git a/rcdk/man/do.aromaticity.Rd b/rcdk/man/do.aromaticity.Rd index 3572a48a30..b582a6494c 100755 --- a/rcdk/man/do.aromaticity.Rd +++ b/rcdk/man/do.aromaticity.Rd @@ -4,7 +4,7 @@ \alias{do.aromaticity} \title{do.aromaticity} \usage{ -\method{do}{aromaticity}(mol) +do.aromaticity(mol) } \arguments{ \item{mol}{The molecule to query. Should be a `jobjRef` representing an `IAtomContainer`} diff --git a/rcdk/man/do.isotopes.Rd b/rcdk/man/do.isotopes.Rd index 26c7136c04..e933de984a 100755 --- a/rcdk/man/do.isotopes.Rd +++ b/rcdk/man/do.isotopes.Rd @@ -4,7 +4,7 @@ \alias{do.isotopes} \title{do.isotopes} \usage{ -\method{do}{isotopes}(mol) +do.isotopes(mol) } \arguments{ \item{mol}{The molecule to query. Should be a `jobjRef` representing an `IAtomContainer`} diff --git a/rcdk/man/get.desc.categories.Rd b/rcdk/man/get.desc.categories.Rd index cee00af00c..df2face092 100755 --- a/rcdk/man/get.desc.categories.Rd +++ b/rcdk/man/get.desc.categories.Rd @@ -7,7 +7,7 @@ get.desc.categories() } \value{ -A character vector listing available descriptor categories. This can be +A character vector listing available descriptor categories. This can be used in \link{get.desc.names} } \description{ diff --git a/rcdk/man/get.volume.Rd b/rcdk/man/get.volume.Rd index ef5295690c..4e0c8a80f3 100755 --- a/rcdk/man/get.volume.Rd +++ b/rcdk/man/get.volume.Rd @@ -13,7 +13,7 @@ get.volume(molecule) A double value representing the volume } \description{ -This method does not require 3D coordinates. As a result its an +This method does not require 3D coordinates. As a result its an approximation } \author{ diff --git a/rcdk/man/view.table.Rd b/rcdk/man/view.table.Rd new file mode 100644 index 0000000000..f6e527d91b --- /dev/null +++ b/rcdk/man/view.table.Rd @@ -0,0 +1,18 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/visual.R +\name{view.table} +\alias{view.table} +\title{view.table} +\usage{ +view.table(molecules, dat, depictor = NULL) +} +\arguments{ +\item{molecules}{A list of molecule objects (`jobjRef` representing an `IAtomContainer`)} + +\item{dat}{The \code{data.frame} associated with the molecules, one per row} + +\item{depictor}{Default \code{NULL}} +} +\description{ +Create a tabular view of a set of molecules (in 2D) and associated data columns +}