-
Notifications
You must be signed in to change notification settings - Fork 4
/
feature_profile.Rd
63 lines (54 loc) · 1.96 KB
/
feature_profile.Rd
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
57
58
59
60
61
62
63
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/feature_profile_class.R
\name{feature_profile}
\alias{feature_profile}
\title{Feature profile}
\usage{
feature_profile(
run_order,
qc_label,
qc_column,
colour_by,
feature_to_plot,
plot_sd = FALSE,
...
)
}
\arguments{
\item{run_order}{(character) The sample-meta column name containing run order.}
\item{qc_label}{(character) The label used to identify QC samples.}
\item{qc_column}{(character) The sample-meta column name containing the labels used to identify QC samples.}
\item{colour_by}{(character) The sample-meta column name to used to colour the plot.}
\item{feature_to_plot}{(numeric, character, integer) The name or column id of the plotted feature.}
\item{plot_sd}{(logical) Plot standard deviation. Allowed values are limited to the following: \itemize{ \item{\code{"TRUE"}: Standard deviation of samples and QCs are included on the plot.}\item{\code{"FALSE"}: Standard deviation is not plotted.}} The default is \code{FALSE}.\cr}
\item{...}{Additional slots and values passed to \code{struct_class}.}
}
\value{
A \code{
feature_profile
} object. This object has no \code{output} slots.
See \code{\link[struct]{chart_plot}} in the \code{struct} package to plot this chart object.
}
\description{
A plot visualising the change in intensity of a feature with a continuous variable such as time, dose, or run order.
}
\section{Inheritance}{
A \code{feature_profile} object inherits the following \code{struct} classes: \cr\cr
\verb{[feature_profile]} >> \verb{[chart]} >> \verb{[struct_class]}
}
\examples{
M = feature_profile(
run_order = character(0),
qc_label = character(0),
qc_column = character(0),
colour_by = character(0),
feature_to_plot = numeric(0),
plot_sd = FALSE)
D = MTBLS79_DatasetExperiment()
C = feature_profile(run_order='run_order',
qc_label='QC',
qc_column='Class',
colour_by='Class',
feature_to_plot=1)
chart_plot(C,D)
}