nmplot {NMTox} | R Documentation |
Create plots of the dose and the response for each nanomaterial in the dataset
Description
This function generates scatter plots of the dose and the response for each nanomaterial in the dataset
Usage
nmplot(data.nm, data.control, id, nano, response, dose, end, end.cat,
unit, unit.cat, type=c("dose","log"), control.opt=c("same","all"), vars,
nrow=1, ncol=1)
Arguments
data.nm |
Data containing the result of toxicity study |
data.control |
Data of control values |
id |
Identifier of the experiment |
nano |
Name of the nanomaterial |
response |
Response (endpoint value) |
dose |
Dose or concentration |
end |
Toxicity endpoint |
end.cat |
Specific toxicity endpoint of interest |
unit |
Unit of measurement of the dose |
unit.cat |
Specific unit of measurement of the dose |
type |
Type of the dose to be plotted (" |
control.opt |
Option for the control doses if |
vars |
Variables used to subset the data |
nrow |
Number of row in the plotting space (default is 1) |
ncol |
Number of column in the plotting space (default is 1) |
Details
This function generates plots for each nanomaterial in the dataset (or for each subset of data). The different types of nanomaterials are identified by their names. Therefore, if some control values are named differently (see:
geninvitro
dataset and theExamples
), a separate dataset containing only these values first needs to be created. Controls in the new dataset can be linked to the non-control observations belonging to the same experiment through the identifier of the experiment (the linking is performed inside this function). In this situation, it is necessary to have an indicator that can identify different experiments (such as experiment ID).If all controls in the dataset are named according to the related nanomaterial names,
data.control
andid
do not need to be specified.If doses used in the experiment are all measured in the same unit of measurement, then specify "
same
" incontrol.opt
.Dose-response plot can also be generated for subsets of data in each nanomaterial, by specifying the variables used to split the data in
vars
.
Value
This function produces plots of the dose and the response for each nanomaterial in the dataset
Examples
# Example 1:
# Create a dataset containing controls (which are named differently)
# from geninvitro dataset:
controldata<-SubsetData(data=geninvitro, x="name", x.cat=c("control", "Control",
"medium", "medium + BSA", "untreated"))
# Exclude controls (which are named differently) from geninvitro dataset:
invitrodata<-SubsetData(data=geninvitro, x="name", x.cat=c("control", "Control",
"medium", "medium + BSA", "untreated"), include=FALSE)
#
# Generate dose-response plot for geninvitro, with DNA STRAND BREAKS as the
# endpoint, concentrations measured in ug/cm2 and controls measured in any
# units of measurement:
#
nmplot(data.nm=invitrodata, data.control=controldata, id="experimentID",
nano="name", response="value", dose="concentration", end="endpoint",
end.cat="DNA STRAND BREAKS", unit="concentration_unit",
unit.cat="ug/cm2", type="dose", control.opt="all")
# Example 2:
# Split geninvitro data according to the cell type and unit of the
# concentration and generate dose-response plot for each
# subset of data with DNA STRAND BREAKS as the endpoint:
#
nmplot(data.nm=invitrodata, data.control=controldata, id="experimentID",
nano="name", response="value", dose="concentration", end="endpoint",
end.cat="DNA STRAND BREAKS", type="dose", nrow=2, ncol=2,
vars=c("celltype","concentration_unit"))