File: sample_dirichlet.Rd

package info (click to toggle)
r-cran-igraph 1.0.1-1%2Bdeb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 18,232 kB
  • sloc: ansic: 173,538; cpp: 19,365; fortran: 4,550; yacc: 1,164; tcl: 931; lex: 484; makefile: 149; sh: 9
file content (38 lines) | stat: -rw-r--r-- 1,096 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/embedding.R
\name{sample_dirichlet}
\alias{sample_dirichlet}
\title{Sample from a Dirichlet distribution}
\usage{
sample_dirichlet(n, alpha)
}
\arguments{
\item{n}{Integer scalar, the sample size.}

\item{alpha}{Numeric vector, the vector of \eqn{\alpha}{alpha} parameter for
the Dirichlet distribution.}
}
\value{
A \code{dim} (length of the \code{alpha} vector for
\code{sample_dirichlet}) times \code{n} matrix, whose columns are the sample
vectors.
}
\description{
Sample finite-dimensional vectors to use as latent position vectors in
random dot product graphs
}
\details{
\code{sample_dirichlet} generates samples from the Dirichlet distribution
with given \eqn{\alpha}{alpha} parameter. The sample is drawn from
\code{length(alpha)-1}-simplex.
}
\examples{
lpvs.dir    <- sample_dirichlet(n=20, alpha=rep(1, 10))
RDP.graph.2 <- sample_dot_product(lpvs.dir)
colSums(lpvs.dir)
}
\seealso{
Other latent position vector samplers: \code{\link{sample_sphere_surface}};
  \code{\link{sample_sphere_volume}}
}