File: README.md

package info (click to toggle)
r-cran-rcdklibs 2.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 80 kB
  • sloc: makefile: 16
file content (56 lines) | stat: -rw-r--r-- 1,846 bytes parent folder | download
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

<!-- README.md is generated from README.Rmd. Please edit that file -->

# rcdklibs

<!-- badges: start -->

[![Build
Status](https://api.travis-ci.org/CDK-R/rcdklibs.svg?branch=master)](https://travis-ci.org/CDK-R/rcdklibs)
[![CRAN
Version](https://www.r-pkg.org/badges/version/rcdklibs?color=green)](https://cran.r-project.org/package=rcdklibs)
[![CRAN
Downloads](http://cranlogs.r-pkg.org/badges/grand-total/rcdklibs?color=green)](https://cran.r-project.org/package=rcdklibs)
[![CRAN Downloads
Monthyl](http://cranlogs.r-pkg.org/badges/last-month/rcdklibs?color=green)](https://cran.r-project.org/package=rcdklibs)
<!-- badges: end -->

The goal of rcdklibs is to provide the [CDK](https://github.com/cdk/cdk)
jarfiles and thereby facilitate chemoinformatic analysis within the R
ecosystem. The primary consumer of `rcdklibs` is the
[rcdk](https://github.com/CDK-R/cdkr) package but all of CDK’s
functionality can be accessed by the standard
[rJava](https://CRAN.R-project.org/package=rJava) API. The libs provided
in this release correspond to the [2.8
Release](https://github.com/cdk/cdk/releases/tag/cdk-2.8)

    # Example
    library(rcdklibs)

    # atm_container class
    atm_container <- J("org/openscience/cdk/AtomContainer")

    # instance of class
    ac1 <- new(atm_container)

    # call method (reflective). slow but easy to program/use.
    ac1$atoms()

    # call method example (static). Cumbersome to program but needed for Java speed.
    .jcall(atom, "Ljavax/vecmath/Point3d;", "getPoint3d")

## Installation

You can install the released version of rcdklibs from
[CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("rcdklibs")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("https://github.com/CDK-R/rcdklibs")
```