launchCMTool: Launch a Tool on ChemMine Tools

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/chemmine_tools.R

Description

Accepts a tool name (string), input options, and input data to launch a remote web tool on the ChemMine Tools website.

Usage

1
launchCMTool(tool_name, input = "", ...)

Arguments

tool_name

A tool name matching verbatim an existing tool name as listed by listCMTools.

input

Input data in the format required for this tool as listed by listCMTools.

...

Additional options as mentioned by running toolDetails on the tool specified.

Details

By running the function toolDetails on a tool of choice, you can see a pre-generated example function call for this tool.

Value

jobToken

for details see ?"jobToken-class"

Author(s)

Tyler William H Backman

References

See ChemMine Tools at http://chemmine.ucr.edu.

See Also

Functions: toolDetails, listCMTools, result, browseJob, status

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## Not run: 
## list available tools
listCMTools()

## get detailed instructions on using a tool
toolDetails("Fingerprint Search")

## download compound 2244 from PubChem
job1 <- launchCMTool("pubchemID2SDF", 2244)

## check job status and download result
status(job1)
result1 <- result(job1)

## End(Not run)

ChemmineR documentation built on May 20, 2017, 10:02 p.m.

Search within the ChemmineR package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.