+
+\end{pmatrix}
+\end{pmatrix}
$$\begin{pmatrix}
\begin{array}{c c | c c}
@@ -1010,7 +1033,7 @@ Kronecker productsas.double() is used to evaluate the result numerically.
-
+
Bmat <- latexMatrix('\\mathbf{B}', ncol=1, nrow=1)
KABmat <- kronecker(A, Bmat)
KAB <- kronecker(A, B)
@@ -1054,7 +1077,7 @@ function can also generate symbolic
equations from numeric or character matrices. For numeric matrices, it
can round the values or show results as fractions.
-
+
A <- matrix(1:12, nrow=3, ncol=4, byrow = TRUE) / 6
matrix2latex(A, fractions = TRUE, brackets = "b") |> Eqn()
.
Create these as a character matrix and vector:
-
+
## [,1] [,2] [,3]
## [1,] "a_1" "a_2" "a_3"
## [2,] "a_4" "a_5" "a_6"
## [3,] "a_7" "a_8" "a_9"
-
+
## [1] "\\beta_1" "\\beta_2" "\\beta_3"
Then use matrix2latex() on cbind(A,b) and
pipe the result of matrix2latex() to
Eqn():
-
+
-
+
## [,1] [,2] [,3]
## [1,] "a_{11}" "a_{12}" "a_{13}"
## [2,] "a_{21}" "a_{22}" "a_{23}"
## [3,] "a_{31}" "a_{32}" "a_{33}"
-
+
showEqn(..., latex = TRUE) produces the three equations
in a single \begin{array} ... \begin{array}
environment.
-
+
showEqn(A, b, vars = x, latex=TRUE)
If this line was run in an R console, it would produce:
\begin{array}{lllllll}
@@ -1134,7 +1157,7 @@ showEqn
Evaluating the above code in an unnumbered LaTeX math environment via
Eqn() gives the desired result:
-
+
-
-
+
+
Three inconsistent equations
diff --git a/docs/authors.html b/docs/authors.html
index c30aea70..44c0b517 100644
--- a/docs/authors.html
+++ b/docs/authors.html
@@ -1,5 +1,5 @@
-Authors and Citation • matlib
+Authors and Citation • matlib
Skip to contents
@@ -7,7 +7,7 @@
matlib
- 0.9.91
+ 0.9.95
diff --git a/docs/index.html b/docs/index.html
index fbd43cd0..d593c30f 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -23,6 +23,8 @@
+
+
Skip to contents
@@ -32,7 +34,7 @@
matlib
- 0.9.91
+ 0.9.95
@@ -140,11 +167,12 @@
Arguments...
-comma separated LaTeX expressions that are either a) a character vector,
+
comma separated LaTeX expressions that are either a) a character vector,
which will be automatically wrapped the
expression inside a call to cat, b) a matrix object
containing character or numeric information, which will be passed latexMatrix,
- or c) an object that was explicitly created via latexMatrix, which
+ along with the information in mat_args, or
+ c) an object that was explicitly created via latexMatrix, which
provides greater specificity.
Note that user defined functions that use cat within
their body should return an empty character vector to avoid printing the
@@ -152,8 +180,13 @@
Argumentslabel
-the equation label used within Eqn or
-defined explicitly in the document
+character vector specifying the label to use (e.g., eq:myeqn), which
+ for LaTeX can be reference via \ref{eq:myeqn} or via the inline function
+ ref. Including a label will also include an equation number automatically.
+For compiled documents if an HTML output is detected (see html_output)
+ then the equations will be labelled via (\#eq:myeqn) and references via \@ref(eq:myeqn),
+ or again via ref for convenience. For Quarto documents the label must be of the
+ form eq-LABEL
align
@@ -161,16 +194,28 @@ Argumentspreview
+logical; render an HTML version of the equation and display? This is intended for
+testing purposes and is only applicable to interactive R sessions. Disabled
+whenever quarto or html_output are TRUE
+
+
html_output
-logical; use references for HTML outputs instead
-of the LaTeX? Automatically changed for compiled documents
-that support knitr
+logical; use labels for HTML outputs instead of the LaTeX? Automatically
+changed for compiled documents that support knitr. Generally not
+required or recommended for the user to modify, except to view the generated syntax
+
+
+quarto
+logical; use Quarto referencing syntax? When TRUE
+the html_output will be irrelevant. Generally not recommended for the
+user to modify, except to view the generated syntax
mat_args
list of arguments to be passed to latexMatrix to change the
-properties of the matrix input objects. Note that these inputs are used globally, and apply to
-each matrix objects supplied. If further specificity is required create
+properties of the matrix input object(s). Note that these inputs are used globally, and apply to
+each matrix object supplied. If further specificity is required create
latexMatrix objects directly.
@@ -181,8 +226,9 @@ Argumentslhs
spacing size. Can be a number between -1 and 6. -1 provides negative
spaces and 0 gives no spacing. Input can also be a character vector, which will be
-passed to \hspace{} (e.g., '1cm').
-Default is 5, resulting in a \quad space
+passed to \hspace{} (e.g., '1cm'; see space argument
+for supported metrics).
+Default is 5, resulting in a \quad space.
mid
@@ -199,10 +245,15 @@ Argumentsspace
+includes extra vertical space. Metric of the vertical space
+must be 'ex', 'pt', 'mm', 'cm', 'em', 'bp', 'dd', 'pc', or 'in'
+
+
string
a string that should have its text size modified. If missing
-the size modifier is returned, which applied the size modifier
-for the remainder of the text until reset with Eqn_size()
+the size modifier is returned, which applies the size modifier
+to the remainder of the text until reset with Eqn_size()
size
@@ -212,8 +263,7 @@ Argumentsparentheses
-logical; include parentheses around the referenced equation?
-Only changes the behaviour for referencing in LaTeX/PDF documents.
+logical; include parentheses around the referenced equation?
3D plot
+
+
3D plot
+
+