From ae13a2e7f373f697cdfb6acb7ae042d6e27d8967 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 24 Mar 2017 15:22:07 +0100 Subject: Add pkgdown docu, change package build directory --- docs/reference/checksubstance.html | 176 +++++++++++++++++++++++++++++++++++++ 1 file changed, 176 insertions(+) create mode 100644 docs/reference/checksubstance.html (limited to 'docs/reference/checksubstance.html') diff --git a/docs/reference/checksubstance.html b/docs/reference/checksubstance.html new file mode 100644 index 0000000..0fbca62 --- /dev/null +++ b/docs/reference/checksubstance.html @@ -0,0 +1,176 @@ + + + + + + + + +Check raw data for a specified substance — checksubstance • drfit + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Check raw data for a specified substance

+
+ + +

Report metadata for a specified substance from a specified database, and plot + the data.

+ + + 
checksubstance(substance, db = "cytotox", experimentator = "%",
+    celltype = "%", enzymetype = "%", organism = "%",
+    endpoint = "%",
+    whereClause = "1", ok = "%")
+ +

Arguments

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
substance

The name of the substance identifying it within the database.

db

The database to be used. Currently, the databases "cytotox" and "enzymes" + of the UFT Department of Bioorganic Chemistry are supported (default is + "cytotox").

experimentator

The name of the experimentator whose data is to be used. Default is "%", + which means that data from all experimentators are shown.

celltype

Currently, only data for IPC-81, C6, NB4, HeLa, Jurkat and U937 are + supported. Default is "%", i.e. data for any cell type will be + displayed.

enzymetype

Currently, only data for AChE, GR and GST are supported. The default value + is "%", i.e. data for any enzyme type will be displayed.

organism

The latin name of the tested organism, if the ecotox db was selected. The + default value is "%", i.e. data for any organism will be displayed.

endpoint

The endpoint that should be used for selecting the data. Only important if + the database "ecotox" is used. Defaults to "%".

whereClause

With this argument, additional conditions for the SQL query can be set, + e.g. "plate != 710". The default is 1 (in SQL syntax this means TRUE).

ok

With the default value "%", all data in the database is retrieved for the + specified substance.

+ +

Value

+ +

The function lists a report and shows one graph.

+ + +

Examples

+ 
# Check substance IM14 BF4 in the cytotox database
+## Not run: checksubstance("IM14 BF4")
+
+ +
+ + +
+ + + -- cgit v1.2.1