CHG: add usage to the README

egpivo · Nov 19, 2023 · 7735a34 · 7735a34
1 parent 472a890
commit 7735a34
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 4 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -8,7 +8,9 @@ Description: Provide regularized maximum covariance analysis incorporating smoot
   sparseness and orthogonality of couple patterns by using the alternating direction method
   of multipliers algorithm. The method can be applied to either regularly or irregularly
   spaced data,  including 1D, 2D, and 3D (Wang and Huang, 2017 <doi:10.1002/env.2481>).
-License: GPL-2
+License: GPL-3
+Depends: 
+    R (>= 3.4.0)
 Imports: Rcpp, RcppParallel (>= 0.11.2), MASS, ggplot2, scales
 LinkingTo: Rcpp, RcppArmadillo, RcppParallel
 Suggests:
@@ -28,3 +30,4 @@ Maintainer: Wen-Ting Wang <[email protected]>
 Encoding: UTF-8
 RoxygenNote: 7.2.3
 Roxygen: list(markdown = TRUE)
+Config/testthat/edition: 3
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,13 @@
+## SpatMCA 1.0.3 (Release date: 2023-11-19)
+#### Overview 
+- Enhance the code coverage from 47% to 58%.
+- Fix bugs of setting default parameters in `spatmca`.
+- Resolve C++ compiler issues from `RcppParallel` and latest R version (> 4)
+- Update the dependencies
+
+---
+
+
 ## SpatMCA 1.0.2.2 (Release date: 2021-02-01)
 #### Overview 
 - Fix singular matrix issues by modifying a setting of an ADMM step parameter.

diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
+# SpatMCA Package
+
 [![R build status](https://github.com/egpivo/SpatMCA/workflows/R-CMD-check/badge.svg)](https://github.com/egpivo/SpatMCA/actions)
 [![Coverage Status](https://img.shields.io/codecov/c/github/egpivo/SpatMCA/master.svg)](https://codecov.io/github/egpivo/SpatMCA?branch=master)
 
-# SpatMCA
-
 ### Description
 
 **SpatMCA** is an R package designed for regularized maximum covariance analysis. It is a powerful tool for:
@@ -28,6 +28,14 @@ brew install gcc
 ```
 For a detailed solution, refer to this [link](https://thecoatlessprofessor.com/programming/rcpp-rcpparmadillo-and-os-x-mavericks-lgfortran-and-lquadmath-error/), or download and install the library [`gfortran`](https://github.com/fxcoudert/gfortran-for-macOS/releases) to resolve the "`ld: library not found for -lgfortran`" error.
 
+### Usage
+```r
+library(SpatMCA)
+spatmca(x1, x2, Y1, Y2, K = 1, num_cores = 1)
+```
+- Input: `x1`, `x2` (location matrices), `Y1`, `Y2` (data matrices), `K` (number of patterns), `num_cores` (number of CPU cores).
+- Output: Provides information about the identified patterns.
+
 
 ### Author
  - [Wen-Ting Wang](https://www.linkedin.com/in/wen-ting-wang-6083a17b "Wen-Ting Wang")
@@ -40,4 +48,4 @@ For a detailed solution, refer to this [link](https://thecoatlessprofessor.com/p
 Wang, W.-T. and Huang, H.-C. (2017). [Regularized spatial maximum covariance analysis](https://arxiv.org/pdf/1705.02716.pdf), Environmetrics, 29, https://doi.org/10.1002/env.2481
 
 ### License
-  GPL-3
+GPL-3