Subtract redundant smoothing constants in mergeDuplicateCollocates
Change-Id: I1b042974735c4b2e9a664e21d1eb87cf0794d5c4
diff --git a/man/mergeDuplicateCollocates.Rd b/man/mergeDuplicateCollocates.Rd
index ba69bf4..9e5e660 100644
--- a/man/mergeDuplicateCollocates.Rd
+++ b/man/mergeDuplicateCollocates.Rd
@@ -2,16 +2,22 @@
% Please edit documentation in R/collocationScoreQuery.R
\name{mergeDuplicateCollocates}
\alias{mergeDuplicateCollocates}
-\title{Merge duplicate collocate rows and re-calculate association scores and urls}
+\title{Merge duplicate collocate rows and re-calculate association scores and URLs.
+Useful if collocation analyses were performed separately for collocates on the
+left and right side of a node.}
\usage{
-mergeDuplicateCollocates(...)
+mergeDuplicateCollocates(..., smoothingConstant = 0.5)
}
\arguments{
\item{...}{tibbles with collocate rows returned from \code{\link[=collocationAnalysis]{collocationAnalysis()}}}
+
+\item{smoothingConstant}{original smoothing constant (to be added only once to the observed values)}
}
\value{
tibble with unique collocate rows
}
\description{
-Merge duplicate collocate rows and re-calculate association scores and urls
+Merge duplicate collocate rows and re-calculate association scores and URLs.
+Useful if collocation analyses were performed separately for collocates on the
+left and right side of a node.
}