Skip to content

SpaceTimeViz/SpatPCA

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SpatPCA: Regularized Principal Component Analysis for Spatial Data

License R build status Coverage Status CRAN_Status_Badge Downloads (monthly) Downloads (total) JCGS

Description

SpatPCA is an R package designed for efficient regularized principal component analysis, providing the following features:

  • Identify dominant spatial patterns (eigenfunctions) with both smooth and localized characteristics.
  • Conduct spatial prediction (Kriging) at new locations.
  • Adapt to regularly or irregularly spaced data, spanning 1D, 2D, and 3D datasets.
  • Implement using the alternating direction method of multipliers (ADMM) algorithm.

Installation

You can install SpatPCA using either of the following methods:

Install from CRAN

install.packages("SpatPCA")

Install the Development Version from GitHub

remotes::install_github("SpaceTimeViz/SpatPCA")

Compilation Requirements

To compile C++ code with the required RcppArmadillo and RcppParallel packages, follow these instructions based on your operating system:

For Windows users

Install Rtools

For Mac users

  1. Install Xcode Command Line Tools
  2. install the gfortran library. You can achieve this by running the following commands in the terminal:
brew update
brew install gcc

For a detailed solution, refer to this link, or download and install the library gfortran to resolve the error ld: library not found for -lgfortran.

Usage

To use SpatPCA, first load the package:

library(SpatPCA)

Then, apply the spatpca function with the following syntax:

spatpca(position, realizations)
  • Input: Realizations with the corresponding positions.
  • Output: Return the most dominant eigenfunctions automatically.

For more details, refer to the Demo.

Authors

Maintainer

Wen-Ting Wang (GitHub)

Reference

Wang, W.-T. and Huang, H.-C. (2017). Regularized principal component analysis for spatial data, "Regularized principal component analysis for spatial data"). Journal of Computational and Graphical Statistics, 26, 14-25.

License

GPL (>= 2)

Citation

  • To cite package ‘SpatPCA’ in publications use:
  Wang W, Huang H (2023). SpatPCA: Regularized Principal Component Analysis for
  Spatial Data_. R package version 1.3.5,
  <https://CRAN.R-project.org/package=SpatPCA>.
  • A BibTeX entry for LaTeX users is
  @Manual{,
    title = {SpatPCA: Regularized Principal Component Analysis for Spatial Data},
    author = {Wen-Ting Wang and Hsin-Cheng Huang},
    year = {2023},
    note = {R package version 1.3.5},
    url = {https://CRAN.R-project.org/package=SpatPCA},
  }