API Reference

Complete Technical Documentation

The API reference provides comprehensive documentation for every function, class, and method in BigDataStatMeth. This documentation is auto-generated from source code to ensure accuracy.

1 Two Interfaces, Same Power

BigDataStatMeth provides the same statistical capabilities through two interfaces, each optimized for its audience. Choose the one that fits your workflow.

2 Choose Your Interface

R Functions

High-level statistical computing

R functions that follow familiar conventions. Automatic error checking and memory management let you focus on statistical methodology.

Function categories:

Linear Algebra
HDF5 Algebra
Block-wise Operations
HDF5 Statistics
HDF5 I/O & Management
Other Functions

Best for: Data analysis, rapid prototyping, R workflows

Browse R functions →

C++ API

Direct access to implementations

Header-only library with explicit control over memory and resources. Same capabilities as R with low-level access.

API categories:

Classes
Functions

Best for: Performance-critical code, system integration, maximum control

Browse C++ API →

3 Using This Reference

Designed for Lookup

This reference is designed for targeted searches, not sequential reading. When you need a specific operation, find the relevant function or class, understand its interface, and apply it.

For R users: Browse by category, study examples, adapt code to your needs.

For C++ users: Navigate to specific classes or functions. Pay attention to memory management requirements.

4 Beyond the Reference

Learn Concepts

Fundamentals

Understand HDF5 storage, block-wise computing, and linear algebra foundations.

Structured Learning

Tutorials

Progressive examples from basics to advanced topics.

Real Applications

Workflows

Complete analyses solving real research problems.

The API reference is the technical specification. Other sections provide the context you need to apply these functions effectively.

--- title: "API Reference" --- ::: {.callout-note icon=false} ## Complete Technical Documentation The API reference provides comprehensive documentation for every function, class, and method in BigDataStatMeth. This documentation is auto-generated from source code to ensure accuracy. ::: ## Two Interfaces, Same Power BigDataStatMeth provides the same statistical capabilities through two interfaces, each optimized for its audience. Choose the one that fits your workflow. --- ## Choose Your Interface ::: {.grid} ::: {.g-col-12 .g-col-md-6} ::: {.callout-tip icon=false} ## R Functions **High-level statistical computing** R functions that follow familiar conventions. Automatic error checking and memory management let you focus on statistical methodology. **Function categories:** - Linear Algebra - HDF5 Algebra - Block-wise Operations - HDF5 Statistics - HDF5 I/O & Management - Other Functions **Best for:** Data analysis, rapid prototyping, R workflows [Browse R functions →](r/index.qmd) ::: ::: ::: {.g-col-12 .g-col-md-6} ::: {.callout-important icon=false} ## C++ API **Direct access to implementations** Header-only library with explicit control over memory and resources. Same capabilities as R with low-level access. **API categories:** - Classes - Functions **Best for:** Performance-critical code, system integration, maximum control [Browse C++ API →](cpp/index.qmd) ::: ::: ::: --- ## Using This Reference ::: {.callout-warning} ## Designed for Lookup This reference is designed for targeted searches, not sequential reading. When you need a specific operation, find the relevant function or class, understand its interface, and apply it. **For R users:** Browse by category, study examples, adapt code to your needs. **For C++ users:** Navigate to specific classes or functions. Pay attention to memory management requirements. ::: --- ## Beyond the Reference ::: {.grid} ::: {.g-col-12 .g-col-md-4} ::: {.callout-tip icon=false} ## Learn Concepts **[Fundamentals](../fundamentals/)** Understand HDF5 storage, block-wise computing, and linear algebra foundations. ::: ::: ::: {.g-col-12 .g-col-md-4} ::: {.callout-tip icon=false} ## Structured Learning **[Tutorials](../tutorials/)** Progressive examples from basics to advanced topics. ::: ::: ::: {.g-col-12 .g-col-md-4} ::: {.callout-tip icon=false} ## Real Applications **[Workflows](../workflows/)** Complete analyses solving real research problems. ::: ::: ::: The API reference is the technical specification. Other sections provide the context you need to apply these functions effectively.