A Simple Way to Specify Symmetric, Block Diagonal Matrices
Overview
Provides a simple mechanism to specify a symmetric block diagonal matrices (often used for covariance matrices). This is based on the domain specific language implemented in 'nlmixr2' but expanded to create matrices in R generally instead of specifying parts of matrices to estimate. It has expanded to include some matrix manipulation functions that are generally useful for 'rxode2' and 'nlmixr2'.
New features
- A block can now be repeated with
same(), which is NONMEM's$OMEGA BLOCK(n) SAME:
```r
lotri({
iov.cl1 + iov.v1 ~ c(0.1,
0.01, 0.2)
iov.cl2 + iov.v2 ~ same()
iov.cl3 + iov.v3 ~ same()
})
```
This is one estimated 2x2 covariance shared by three blocks, which is
Show all changes in 1.0.5Hide the rest of the changes in 1.0.5
how inter-occasion variability is parameterized when every occasion
draws its own random effects from one shared covariance -- and it is
what lets those random effects be *correlated*.
same() repeats the immediately preceding block under new names and
takes no arguments. A further same() repeats that same original
block rather than the copy, the way NONMEM chains SAME. It works
with a condition (iov.cl2 + iov.v2 ~ same() | occ), it inherits the
fixed flags of the block it repeats, and it composes with the
cnd(same = n) nesting property that lotriSep() uses.
- **The
conditioncolumn can now carry a:same:suffix.** Rather than adding a column to the data frame fromas.data.frame(), a repeated block records the element it mirrors in the existingconditioncolumn, naming it: ``<baseCondition>:same:<masterEta> # diagonal row <baseCondition>:same:<masterEta1>:<masterEta2> # covariance row`The master is named rather than indexed becauseneta1/neta2are renumbered whenever parameters are added, dropped or reordered. A copy keeps its master'sestandfix, so a consumer that does not understand the suffix still sees a numerically correct matrix -- just with more free parameters than the model really has. Four helpers are exported for reading that column, and code that comparesconditiondirectly (condition == "id"`) should move to them, since such a test misclassifies a repeated block: lotriBaseCondition()strips the suffix,lotriIsSame()says whether a row mirrors another,lotriSameMap()maps each eta to the eta it mirrors,lotriSameBreak()drops the linkage for a block that has been structurally changed.
same() round trips through as.data.frame(), as.lotri() and
as.expression(), and the linkage is carried across lotriMat().
A repetition that no longer describes a real mirror -- because the
blocks it was built from were reordered or dropped, or because it
carries something same() cannot express -- is written out with its
explicit values instead. That loses the annotation, never the
numbers.
A prior cannot be put on a repeated block -- it is not a parameter of
its own, so the prior belongs on the block it mirrors. Without this
a model could carry two different priors on what is one estimated
parameter.
same() cannot be combined with a cov function, nor with
rcm=TRUE on a matrix the permutation would actually reorder; both
would move a repeated block away from the block it repeats, and are
refused rather than silently producing a matrix whose repetition is
no longer true. A same() matrix that is already block diagonal is
left alone, since there rcm is a no-op, which keeps rxode2's
ini({}) -- which always passes rcm=TRUE -- working.
- Prior distributions can now be specified in a
lotri({})(and thereforeini({})) block withprior(name) ~ dist(...), ie:
```r
lotri({
tka <- 0.45
tcl <- c(0, 1, 10)
eta.cl + eta.v ~ c(0.1,
0.01, 0.2)
prior(tka) ~ dnorm(0, 10)
prior(tcl) ~ dlnorm(1, 0.5)
prior(eta.cl, eta.v) ~ lkjCorr(2)
})
```
Because the statement names its target, prior lines may be given
anywhere in the block. Priors may be put on population estimates,
on individual etas, and on whole covariance blocks (with the
matrix-valued distributions like lkjCorr() and invWishart()).
Every distribution has three accepted spellings: the R name where R
parameterizes it the same way 'Stan' does (dnorm(), dlnorm(),
dgamma()), the camelCase name (invWishart(), lkjCorr(),
studentT()), and the 'Stan' name itself (inv_wishart(),
lkj_corr(), student_t()). The canonical spelling, which is what
is stored and printed back, is the R one where there is a faithful
one and the camelCase one otherwise. Both positional and named
arguments work. lotri validates the distribution name, its arity,
and its support against the parameter's bounds; it does not generate
any 'Stan' code.
- An inverse Wishart prior on an omega block can be given by its degrees of freedom alone, since the block it is put on already is the scale matrix. This is the
$OMEGAP/$OMEGAPDpair of a NONMEMNWPRImodel:
```r
lotri({
eta.cl + eta.v ~ c(0.1,
0.01, 0.2)
prior(eta.cl, eta.v) ~ invWishart(4)
})
```
It works on a 1x1 block too (an inverse Wishart of dimension one is
an inverse gamma), and an improper nu <= p - 1 is an error.
- A normal prior can be put on the omega values themselves, which is what a NONMEM
TNPRImodel needs.om.prepended to a between subject variability names its omega element, so the normal prior shorthand can be used on it:
```r
lotri({
eta.cl ~ 0.3
eta.v ~ 0.1
om.eta.cl ~ 0.01
om.eta.v ~ 0.04
})
```
The omega itself is untouched; only the prior is added. Correlated
omega priors work the same way, including the per row line form. An
om. name has to match a real between subject variability and never
creates one. prior(om.eta.cl) and prior(eta.cl) mean the same
thing; the om. spelling exists so the shorthand has a name to put
on the left of a ~, since eta.cl ~ ... already means the omega
value.
Degrees of freedom and a normal prior are alternative ways of putting
a prior on an omega, so a model that gives both is an error.
- Because normal priors are so common they also have a shorthand that reuses the matrix syntax: putting a *population estimate* on the left of a
~gives it a normal prior with a zero mean and the given variance.
```r
lotri({
tka <- 1
tcl <- 3
tv <- 4
tka ~ 4 # tka ~ N(0, sd=2)
tcl + tv ~ c(1, # (tcl, tv) ~ MVN(0, Sigma)
0.01, 1)
})
```
All of the matrix spellings work here, including the per row line form
(tcl ~ 1; tv ~ c(0.01, 1)) and the sd(), var(), cor(), cov()
and chol() transformations. The <- value remains the initial
estimate; it is not the prior mean. An uncorrelated block simply
becomes independent normal priors. A zero variance is an error.
Note this changes behavior: lotri({b <- 3; b ~ 0.4}) used to be a
"duplicated parameter" error and is now a normal prior on b. A name
that is not an estimate still specifies an eta as before.
- Added
lotriPriorDists()which returns the table of supported distributions (including the 'Stan' name for each), so that downstream packages can generate the corresponding 'Stan' code. - The
lotriEstdata frame andas.data.frame()output gained apriorcolumn. prior()also takes the normal prior shorthand, soprior(tka) ~ 0.1means whattka ~ 0.1means:
```r
lotri({
tka <- 0.45
prior(tka) ~ 0.1 # dnorm(0.45, sqrt(0.1))
prior(tcl, tv) ~ c(1, # multivariate, centered on the estimates
0.01, 1)
})
```
Every matrix spelling works here as it does bare, including the per
row line form, so a covariance can be built up a line at a time:
```r
lotri({
tcl <- 3
tv <- 4
prior(tcl) ~ 1
prior(tv) ~ c(0.001, 1) # same 2x2 as tcl ~ 1; tv ~ c(0.001, 1)
})
```
An uncorrelated group becomes independent normal priors, and the mean
is what the model already says. Note the line form is the one place a
prior line is *not* order independent, since a row leans on the line
before it. The point is that a bare ~ cannot be used
everywhere -- piping onto a model reads tka ~ 0.1 as changing the
estimate -- so the prior() flag gives the shorthand a spelling that
works when piping too.
A namespaced distribution such as stats::dnorm(0, 1) is now an
error rather than being evaluated as a variance.
- A univariate prior (
dnorm(),dcauchy(), ...) can now be put on a single omega COVARIANCE (off-diagonal) element, not just a diagonal one -- a marginal, independent prior on that one cell, distinct from a whole-block distribution likeinvWishart()/multiNormal():
```r
lotri({
eta.cl + eta.v ~ c(0.1,
0.01, 0.2)
prior(eta.cl, eta.v) ~ dnorm(0, 0.1)
})
```
The two names must covary with each other but need not be the model's
*entire* connected block -- prior(eta.cl, eta.v) works even when a third,
correlated eta is also in the block, unlike a whole-block prior which
still requires naming every member. prior(om.eta.cl, om.eta.v) ~ ...
is accepted identically. A block cannot carry both a whole-block
invWishart()/multiNormal() prior and a marginal prior on one of its
own cells -- these remain alternatives, not additions.
Bug fixes
- A condition written on a continuation no longer relocates unrelated parameters. The rows of one block share a level of variability because they covary, so a condition on a later row carries that block over -- but it used to carry the whole default level with it, so parameters declared long before, and unrelated to the block, silently changed level.
- A line that cannot be parsed at the default level is no longer folded into the most recently *seen* condition. It is folded only when the block immediately before it is at that level, which is what the fallback was for; otherwise a parameter with no condition could land at a level of variability it was never given.
- Labels are no longer lost, or attached to the wrong parameter, when a block has more than one level of variability. Which level a trailing
label()belonged to was decided by whether the DEFAULT level had any labels yet, so once it did, a conditioned line's label landed on the default level and overwrote the one already there; andas.data.frame()only ever read the labels of a single matrix, so a conditioned object lost them entirely. as.lotri()on a data frame whose only level of variability is notidnow keeps that level's name. It previously returned a bare matrix, so an occasion-only model came back looking like an id level one.lotriEst(x, drop=TRUE)kept thelotriFixclass only when there were fixed elements, so a matrix carrying labels, priors or asame()repetition came back unclassed with the attribute orphaned and every consumer dispatching to the default method.- A plus-form block, or a block whose right hand side is arithmetic (
d ~ 0.1*2), written after a line-form block overwrote the rows the line form had just written. A line-form block leaves the row counter pointing at its FIRST row with the rest held separately, and neither branch settled that, solotri({a ~ 1; b ~ c(0.1, 2); c1 + d1 ~ c(3, 0.2, 4)})failed with "length of 'dimnames' [1] not equal to array extent". The same applied to a 1x1 block under a condition. - A conditioned block written in the line form lost every row after the first.
a ~ 1 | occdid not set thelastNcounter the line form accumulates through, so a followingb ~ c(0.1, 2) | occcould not see the row before it and the block was silently truncated to 1x1. This showed up aseval(as.expression(x))returning a smaller matrix thanxfor any conditioned block of more than one parameter. lotri()read its own condition-property list with a partially-matchingattr(). Because"lotri"is a prefix of"lotriLabels","lotriFix"and friends, combining a conditioned matrix with a labelled one (as inlotri(lotri(b ~ 2) | occ, lotri({c ~ 1; label("z")}))) picked up the neighbouring attribute, attached it as the property list, and gave the result a spuriouslotriclass and a bogusProperties:line. The internal reads are now exact.lotrinow requires 'armadillo4r' 15.4.2 or newer. The 'Armadillo' headers shipped with older 'armadillo4r' releases discard the return value of astd::uniform_int_distributiondraw, which the 'libc++' shipped with 'clang' 23 now marks[[nodiscard]]. That madeR CMD checkreport a significant compilation warning -- and so a checkWARNING-- on CRAN's clang-trunk flavour, even though none oflotri's own sources were involved (#57).src/nearPD.cppandsrc/rcm.cppnow include<algorithm>,<cmath>and<cstddef>for thestd::fill/std::fill_n,std::max,std::absandstd::size_tthey use directly, instead of relying on the 'Armadillo' headers to drag them in. 'libc++' has been steadily dropping transitive includes, and clang 23's is where that started breaking packages (#57).- The
trace=TRUEiteration message inlotriNearPD()printed anarma::uwordwith%lld; it now uses%lluwith an explicit cast, so the format matches the argument on every 'Armadillo' word-size configuration (#57). - The test suite no longer calls
structure()with the deprecated special names.Dim,.Dimnamesand.Names; it usesdim,dimnamesandnamesinstead. This clears the "Found calls to structure() using deprecated special names"NOTEon the r-devel check flavours (#57). - A
prior()given for a fixed (fix()ed) parameter is now an error at resolution time, naming the parameter, instead of parsing and building cleanly and only surfacing as a problem in whatever consumes the priors. A fixed parameter is a constant, so it cannot carry a prior; this applies to a univariate prior row, a member of a multivariate prior, and an omega-block member on a fixed omega element alike, and also to a block prior (lkjCorr(),invWishart()) whose block has a fixed covariance even if every variance in it is free. The implicit~invWishart(4)shorthand, which applies to every omega block in the model, quietly skips a block that is entirely fixed instead (#52). lotri()can now re-parse the namedc()form thatlotriAsExpression()/as.expression()writes for a matrix abovenameEst's size threshold when a later row's names reach back into an earlier, already-closed block -- as happens for a combined theta+omega covariance matrix, where every omega row names all the preceding theta rows too. Previously anom.-prefixed row in that position was always misread as theom.normal prior shorthand instead of the next row of the matrix itself (#53).- Labels now follow the matrix when
rcm=TRUEre-orders it. Previously the labels stayed in the order they were parsed in while the matrix was permuted, so they were applied to the wrong parameters. lotriLabelsare no longer dropped when matrices are combined (ielotri(mat1, mat2)orlotriMat()); they are now concatenated in C along with the matrix itself.as.expression()now works on alotriobject that has only population estimates and no matrix; it used to fail with "second argument must be a list".lotriNearPD(x, only.values=TRUE)no longer fails with "unknown c++ error" whenxis already positive definite. The eigenvalues were only returned from inside the branch that clamps a negative eigenvalue, so an input that needed no clamping fell through and tried to assign the full matrix into a length-nresult.- Fixed rchk issues and small bugs found while linting
From NEWS.md in the release
Install
Health
- OK13 OK2026-09-17
- NOTE11 OK, 2 NOTE2026-07-16
- OK14 OK2026-03-10
Documentation
- Help pages
- 14 (1 internal)
- Examples that run
- 100%12 run in a plain check
- Exported functions with examples
- 86%
- Documented parameters
- 98%
- Return-value docs
- 93%
- Help pages citing references
- 7%
Downloads
Repository
- PRs merged (all time)
- 92%
- Median days to close, 50 most recently updated closed issues
- 2
- Median days to close, 50 most recently updated closed PRs
- 0
Stars over time
Forks over time
Releases over time
Issues over time
PRs over time
Commits over time
10 development-tooling and community-health practices detected across 5 families in the upstream repository
Checks run against github.com/nlmixr2/lotri on 2026-10-11.
The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel
GitHub Pages site last deployed 2026-09-11 · The repository has a site deploy workflow
pkgdown site last built 2026-09-11
Show all practicesHide 1 practice
This repository shows signs of AI coding tools.
- Claude Codefirst seen 2026-04-02Seen in the repository: CLAUDE.mdNamed in .Rbuildignore: .claude, CLAUDE.mdPull request it wrote: opened by a project memberCommits: at least 5 crediting it in the message
- GitHub Copilotfirst seen 2026-04-03Commits: 1 by its own account
- Antigravityfirst seen 2026-05-13Named in .Rbuildignore: .antigravity
- Claude CodePull requests: 1 from outside contributors, first on 2026-06-15
- Claude Sonnet 4.63 commits · Apr 2026
- Claude Opus 4.82 commits · Jun 2026
Dependencies
Installing lotri adds 5 packages (2 with compiled code, 1.5 MB of source tarballs). Heaviest: armadillo4r 1.0 MB, checkmate 247 KB, cpp4r 203 KB.
Code & Tests
People & History
Pick two releases to compare their code metrics.
- 1.0.5Latest2026-09-11 · current release · diff ↗ ·
added 5 exports
lotriBaseCondition, lotriIsSame, lotriPriorDists, lotriSameBreak, lotriSameMap - 1.0.42026-05-14 · diff ↗
- RR 4.6.0 released · 2026-04-24
- 1.0.32026-03-11 · diff ↗
- 1.0.22025-08-29 · diff ↗
- 1.0.12025-07-18 · diff ↗
- RR 4.5.0 released · 2025-04-11
- 1.0.02024-09-18 · diff ↗ ·
added 5 exports
.lotriPointers, lotriAsExpression, lotriIsBlockMat, lotriNearPD, rcm - RR 4.4.0 released · 2024-04-24
- RR 4.3.0 released · 2023-04-21
- 0.4.32023-03-20 · diff ↗
- 0.4.22022-06-18 · diff ↗
- RR 4.2.0 released · 2022-04-22
- 0.4.12022-04-21 · diff ↗
- 0.4.0
- RR 4.1.0 released · 2021-05-18
Package metadata
- First published
- 2019-05-14
- Total releases
- 14 / 7 yrs
- License
- GPL (>= 2) OSI
- Minimum R
- ≥ 3.4.0
- Download size
- 339 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("lotri")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-18, which the citation names so these numbers can be found later. More on citing and the projects behind them.