further refine package index

Author: lschneiderbauer

R/tensor.R

@@ -70,7 +70,7 @@ tensor_new_dummy_index_name <- function(x, n = 1) {
 #' @param call For internal use only.
 #' @export
 #' @rdname create-tensor
-#' @concept tensor
+#' @concept tensor_create
 #' @importFrom cli cli_abort
 tensor <- function(a, index_names, index_positions, call = NULL) {
   rlang::check_required(a)
@@ -420,7 +420,7 @@ print.tensor <- function(x, ...) {
 #' @examples
 #' array(1:8, dim = c(2, 2, 2)) %_% .(i, +i, k) |> as.array(.(k))
 #' @export
-#' @concept tensor
+#' @concept tensor_dest
 as.array.tensor <- function(x, index_order = NULL, ...,
                             arg = "index_order",
                             call = rlang::caller_env()) {
@@ -470,7 +470,7 @@ as.array.tensor <- function(x, index_order = NULL, ...,
 #' @export
 #' @seealso The same functionality is implemented in [as.array.tensor()]
 #'  but with standard evaluation.
-#' @concept tensor
+#' @concept tensor_dest
 as_a <- function(x, ...) {
   as.array(x, .(...), arg = "...")
 }

R/tensor_indices.R

@@ -73,7 +73,7 @@
 #' # one lower and upper index
 #' .(i, +j)
 #' @export
-#' @concept tensor
+#' @concept tensor_create
 . <- function(...) {
   exprs <- rlang::enexprs(...)
 

_pkgdown.yml

@@ -4,10 +4,21 @@ template:
   math-rendering: katex
 
 reference:
-- title: "Label and unlabel tensors"
+- title: "Label and unlabel arrays"
+  desc: >
+    Adding index names enables the usage of Ricci calculus rules,
+    while unlabeling restores the usual R array.
+- subtitle: Label arrays
   contents:
-  - has_concept("tensor")
+  - has_concept("tensor_create")
+- subtitle: Unlabel arrays
+  contents:
+  - has_concept("tensor_dest")
 - title: "Tensor operations"
+  desc: >
+    Working with labeled arrays allows to consicely specify
+    various tensor operations who all take given index structures
+    into account and act accordingly.
 - subtitle: "Index manipulation"
   contents:
   - has_concept("index")
@@ -21,6 +32,9 @@ reference:
   contents:
   - has_concept("eval")
 - title: "Tensor fields"
+  desc: >
+    Tensor fields can be modeled by symbolic tensors, i.e. tensors
+    that contain mathematical expressions instead of numerical values.
 - subtitle: "Covariant derivative"
   contents:
   - covd
@@ -34,5 +48,8 @@ reference:
   contents:
   - has_concept("tensor_symbols")
 - title: "Testthat expectation"
+  desc: >
+    A simple testthat helper that allows to check for
+    tensor equality.
   contents:
   - expect_tensor_equal