First working package
Change-Id: I7f011864775a0486d6dd985b93e4473574956fa7
diff --git a/man/collocationScores.Rd b/man/collocationScores.Rd
new file mode 100644
index 0000000..b206e18
--- /dev/null
+++ b/man/collocationScores.Rd
@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/derekovecs.R
+\name{collocationScores}
+\alias{collocationScores}
+\title{collocationScores}
+\usage{
+collocationScores(w, c, ...)
+}
+\arguments{
+\item{w}{The target word/node.}
+
+\item{c}{The collocate.}
+
+\item{...}{Additional parameters to pass to the API.}
+}
+\value{
+A one row data frame with collocate and its association scores.
+}
+\description{
+Calculate the association scores between a node (target word) and words in a window around the it.
+}
diff --git a/man/cosineSimilarity.Rd b/man/cosineSimilarity.Rd
new file mode 100644
index 0000000..5b30c89
--- /dev/null
+++ b/man/cosineSimilarity.Rd
@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/derekovecs.R
+\name{cosineSimilarity}
+\alias{cosineSimilarity}
+\title{cosineSimilarity}
+\usage{
+cosineSimilarity(w1, w2, ...)
+}
+\arguments{
+\item{w1}{The first word.}
+
+\item{w2}{The second word.}
+
+\item{...}{Additional parameters to pass to the API.}
+}
+\value{
+The cosine similarity between the two words.
+}
+\description{
+Calculate the cosine similarity between two words in the derekovecs model.
+}
diff --git a/man/countbasedCollocates.Rd b/man/countbasedCollocates.Rd
new file mode 100644
index 0000000..c3f153f
--- /dev/null
+++ b/man/countbasedCollocates.Rd
@@ -0,0 +1,19 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/derekovecs.R
+\name{countbasedCollocates}
+\alias{countbasedCollocates}
+\title{countbasedCollocates}
+\usage{
+countbasedCollocates(w = "Test", ...)
+}
+\arguments{
+\item{w}{The word to get the collocates for.}
+
+\item{...}{Additional parameters to pass to the API.}
+}
+\value{
+A data fram with the most salient collcates and their association scores.
+}
+\description{
+Get the collocates of a word in the count-based dereko model.
+}
diff --git a/man/derekovecsApiCall.Rd b/man/derekovecsApiCall.Rd
new file mode 100644
index 0000000..a84757f
--- /dev/null
+++ b/man/derekovecsApiCall.Rd
@@ -0,0 +1,19 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/derekovecs.R
+\name{derekovecsApiCall}
+\alias{derekovecsApiCall}
+\title{DeReKoVecsCall}
+\usage{
+derekovecsApiCall(method = "", ...)
+}
+\arguments{
+\item{method}{The method to call.}
+
+\item{...}{The parameters to pass to the method.}
+}
+\value{
+The result of the call.
+}
+\description{
+Call the DeReKoVecs API.
+}
diff --git a/man/derekovecsServer.Rd b/man/derekovecsServer.Rd
new file mode 100644
index 0000000..4ef9089
--- /dev/null
+++ b/man/derekovecsServer.Rd
@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/derekovecs.R
+\name{derekovecsServer}
+\alias{derekovecsServer}
+\title{DeReKoVecsServer}
+\usage{
+derekovecsServer()
+}
+\value{
+The URL of the DeReKoVecs API server.
+}
+\description{
+DeReKoVecsServer
+}
diff --git a/man/paradigmaticNeighbours.Rd b/man/paradigmaticNeighbours.Rd
new file mode 100644
index 0000000..225dae7
--- /dev/null
+++ b/man/paradigmaticNeighbours.Rd
@@ -0,0 +1,19 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/derekovecs.R
+\name{paradigmaticNeighbours}
+\alias{paradigmaticNeighbours}
+\title{paradigmaticNeighbours}
+\usage{
+paradigmaticNeighbours(word = "Test", ...)
+}
+\arguments{
+\item{word}{The word to get the paradigmatic neighbours for.}
+
+\item{...}{Additional parameters to pass to the API.}
+}
+\value{
+A list of words with their similarity scores.
+}
+\description{
+Get the paradigmatic neighbours of a word in the derekovecs model.
+}
diff --git a/man/pipe.Rd b/man/pipe.Rd
new file mode 100644
index 0000000..a648c29
--- /dev/null
+++ b/man/pipe.Rd
@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils-pipe.R
+\name{\%>\%}
+\alias{\%>\%}
+\title{Pipe operator}
+\usage{
+lhs \%>\% rhs
+}
+\arguments{
+\item{lhs}{A value or the magrittr placeholder.}
+
+\item{rhs}{A function call using the magrittr semantics.}
+}
+\value{
+The result of calling \code{rhs(lhs)}.
+}
+\description{
+See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+}
+\keyword{internal}
diff --git a/man/syntagmaticNeighbours.Rd b/man/syntagmaticNeighbours.Rd
new file mode 100644
index 0000000..6278606
--- /dev/null
+++ b/man/syntagmaticNeighbours.Rd
@@ -0,0 +1,19 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/derekovecs.R
+\name{syntagmaticNeighbours}
+\alias{syntagmaticNeighbours}
+\title{syntagmaticNeighbours}
+\usage{
+syntagmaticNeighbours(word = "Test", ...)
+}
+\arguments{
+\item{word}{The word to get the syntagmatic neighbours for.}
+
+\item{...}{Additional parameters to pass to the API.}
+}
+\value{
+Data frame syntagmatic neighbours of a word from the predictive derekovecs model.
+}
+\description{
+Get the syntagmatic neighbours of a word from the predictive derekovecs model.
+}