Commit 23bdc2ae authored by amillan's avatar amillan
Browse files

🔧 documentation updated of version 1.3.0

parent 81c776bf
Package: metaprotr
Title: Metaproteomics Post-Processing Analysis
Version: 1.3.1
Version: 1.3.0
Date: 2021-05-17
Authors@R: c(
person("Aaron", "Millan-Oropeza", email = "aaron.ibt@gmail.com", role = c("aut", "cre")),
......
......@@ -7,6 +7,7 @@
plot_dendocluster(
spectral_count_object,
target_variable,
samples_label,
file_title,
hclust_method = "ward.D",
correlation_method = "spearman",
......@@ -22,7 +23,11 @@ of this object is similar to that generated from the functions
\item{target_variable}{Character indicating the name of one column
from metadata. The different levels in this column will be represented
as different colors in the final dendogram.}
as different colors in the final dendrogram.}
\item{samples_label}{Character indicating the name of one column from
metadata. The name of different elements of this variable will be
displayed on the dendrogram plot.}
\item{file_title}{Character indicating the name of the generated file.}
......@@ -40,11 +45,11 @@ The default value is "spearman".}
permission to create a pdf file in the workstation of the user.}
}
\value{
A dendogram plot (pdf) indicating the number of elements per
A dendrogram plot (pdf) indicating the number of elements per
sample.
}
\description{
Draws a dendogram where samples are clustered based on the number of elements
Draws a dendrogram where samples are clustered based on the number of elements
present on each sample from a "spectral_count_object". This graph is
constructed based on Spearman correlations transformed into distances
and plotted with the logic of the package
......@@ -56,12 +61,12 @@ and plotted with the logic of the package
data(fecal_waters)
str(fecal_waters$metadata)
plot_dendocluster(fecal_waters, "Condition", "title_dendogram")
plot_dendocluster(fecal_waters, "Condition", "SC_name", "title_dendogram")
plot_dendocluster(fecal_waters, "Condition", "title_dendogram",
plot_dendocluster(fecal_waters, "Condition", "SC_name", "title_dendogram",
hclust_method = "mcquitty")
plot_dendocluster(fecal_waters, "Condition", "title_dendogram_groups",
plot_dendocluster(fecal_waters, "Condition", "SC_name", "title_dendogram_groups",
correlation_method = "pearson")
\dontshow{setwd(.old_wd)}
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment