Skip to content

Commit

Permalink
slight rewording of man page for lav_use_lavaanC
Browse files Browse the repository at this point in the history
  • Loading branch information
yrosseel committed Dec 4, 2024
1 parent 3105868 commit ca9455a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: lavaan
Title: Latent Variable Analysis
Version: 0.6-20.2240
Version: 0.6-20.2247
Authors@R: c(person(given = "Yves", family = "Rosseel",
role = c("aut", "cre"),
email = "[email protected]",
Expand Down
14 changes: 8 additions & 6 deletions man/lav_use_lavaanC.Rd
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
\name{lav_use_lavaanC}
\alias{lav_use_lavaanC}
\alias{uselavaanC}
\title{use C++ code in lavaanC}
\title{Use C++ Code From The lavaanC Package In lavaan}
\description{
Get or set switch to use the C++ code in lavaanC.}
This function provides a global switch to switch on/off the use
of C++ code (from the lavaanC package) in lavaan.}
\usage{
lav_use_lavaanC(x)
}
\arguments{
\item{x}{Optional scalar logical to set the switch ON or OFF.}
\item{x}{Logical. Optional logical to set allow for the use of C++ code within lavaan}
}
\value{
If \code{x} is missing the current value of the switch (logical).
If \code{x} is provided invisible(NULL).
}
\details{
The default value of the switch is ON (TRUE) if the \code{lavaanC} is available and
OFF (FALSE) if it is not. The switch cannot be set to TRUE if \code{lavaanC} is not available
(a warning message is issued).
The default value of the switch is ON (TRUE) if the \code{lavaanC} is
installed and available and OFF (FALSE) if it is not. The switch cannot
be set to TRUE if \code{lavaanC} is not available and will result in a
warning message.
}
\examples{
lav_use_lavaanC(FALSE)
Expand Down

0 comments on commit ca9455a

Please sign in to comment.