diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2016-09-27 16:43:15 +0200 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2016-09-27 17:37:54 +0200 |
| commit | 5bec469048899cfd785dec4f91ec3840cff18adb (patch) | |
| tree | 438cd0d932466628ec9e486121cb9e56b2821f62 | |
| parent | 1532aadbd632a3b82032de3f0b0f377660617a9f (diff) | |
Add a bit of info to README
| -rw-r--r-- | GNUmakefile | 1 | ||||
| -rw-r--r-- | README.md | 12 | ||||
| -rw-r--r-- | docs/index.html | 14 |
3 files changed, 27 insertions, 0 deletions
diff --git a/GNUmakefile b/GNUmakefile index b88fb85..d15273d 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -11,6 +11,7 @@ usage: @echo "Usage: make TARGET with TARGET being:" @echo "" @echo " roxygen - Roxygenize." + @echo " sd - Roxygenize and build static docs." @echo " build - Build source package." @echo " check - Run check on the package." @echo " crancheck - Run CRAN check on the package." @@ -16,3 +16,15 @@ This means: You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/> + +## Features + +- Some chemical information is retrieved from the PubChem website using the webchem +package +- If PythonInR is installed and configured, and RDKit is available via +PythonInR, some additional chemical information is computed and a 2D graph can +be plotted +- Additional information can be read from a local .yaml file + +Some examples are available from the +[Reference on github](https://jranke.github.io/chents/reference.html). diff --git a/docs/index.html b/docs/index.html index 579c9f3..3582067 100644 --- a/docs/index.html +++ b/docs/index.html @@ -71,6 +71,20 @@ You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/> </code></pre> +<h2>Features</h2> + +<ul> +<li>Some chemical information is retrieved from the PubChem website using the webchem +package</li> +<li>If PythonInR is installed and configured, and RDKit is available via +PythonInR, some additional chemical information is computed and a 2D graph can +be plotted</li> +<li>Additional information can be read from a local .yaml file</li> +</ul> + +<p>Some examples are available from the +<a href="https://jranke.github.io/chents/reference.html">Reference on github</a>.</p> + </div> <div class="span3 offset1 sidebar"> |