---
title: "Grouped Hyper Data Frame"
author: Tingting Zhan
date: today
format: 
  html:
    page-layout: full
    html-math-method: katex
    link-external-icon: true
    link-external-newwindow: true
number-sections: true
toc: true
toc-location: left
toc-depth: 4
toc-title: ''
editor: source
bibliography: groupedHyperframe.bib
knitr:
  opts_chunk: 
    collapse: true
    comment: "#" 
vignette: >
  %\VignetteIndexEntry{intro}
  %\VignetteEngine{quarto::html}
  %\VignetteEncoding{UTF-8}
---


A [Quarto](https://quarto.org) book of R package **`groupedHyperframe`** (v`r packageVersion('groupedHyperframe')`) 

> <https://tingtingzhan.quarto.pub/groupedhyperframe/>

documents

-   the creation of *grouped hyper data frame*;
-   the creation of a grouped hyper data frame with one-and-only-one point-pattern hypercolumn;
-   the batch process on eligible marks for the one-and-only-one point-pattern hypercolumn in a (grouped) hyper data frame;
-   the computation of various summary statistics from one or more function-value-table hypercolumn(s) of a (grouped) hyper data frame;
-   the aggregation of summary statistics, over a (nested) grouping structure, in a grouped hyper data frame.

The complete book exceeds the file size limit allowed on [CRAN](https://cran.r-project.org/package=groupedHyperframe).  



# Prerequisite

## Environment

Package **`groupedHyperframe`** (v`r packageVersion('groupedHyperframe')`) requires R version 4.5.0 (released 2025-04-11) or higher ([macOS](https://cran.r-project.org/bin/macosx/), [Windows](https://cran.r-project.org/bin/windows/base/), [Linux](https://cran.r-project.org/bin/linux/)).

An Integrated Development Environment (IDE), e.g., [RStudio](https://posit.co/download/rstudio-desktop/) [@RStudio] or [Positron](https://positron.posit.co/download.html), is not required, but highly recommended.


```{r}
#| code-fold: true
#| code-summary: "Environment on author's computer"
#| label: author-env
Sys.info()[c('sysname', 'release', 'machine')]
R.version
```

## Enhancement & Dependency

Package **`groupedHyperframe`** (v`r packageVersion('groupedHyperframe')`) `Enhances` the **`spatstat.*`** family of packages [@spatstat15; @spatstat05], especially **`spatstat.geom`** and **`spatstat.explore`**. Details are provided in the [book](https://tingtingzhan.quarto.pub/groupedhyperframe/), Section 7.1.


The dependencies of package **`groupedHyperframe`** are detailed in the [book](https://tingtingzhan.quarto.pub/groupedhyperframe/), Section 7.1. 


Package **`groupedHyperframe`** requires the *development versions* of the **`spatstat.*`** family of packages. Installation instructions are provided in the [book](https://tingtingzhan.quarto.pub/groupedhyperframe/), Section 7.1. 


## Installation

Package **`groupedHyperframe`** (v`r packageVersion('groupedHyperframe')`) can be installed using the following command.

```{r}
#| eval: false
utils::install.packages('groupedHyperframe')
```


# Acknowledgement

This work is supported by National Institutes of Health, U.S. Department of Health and Human Services grants

-   R01CA222847 ([I. Chervoneva](https://orcid.org/0000-0002-9104-4505), [T. Zhan](https://orcid.org/0000-0001-9971-4844), and [H. Rui](https://orcid.org/0000-0002-8778-261X))
-   R01CA253977 (H. Rui and I. Chervoneva).




# References {.appendix}

::: {#refs}
:::