Re-document package

coatless-rpkg · Nov 14, 2023 · 1bf10d2 · 1bf10d2
1 parent 3fe9ff3
commit 1bf10d2
Show file tree

Hide file tree

Showing 22 changed files with 184 additions and 159 deletions.
diff --git a/R/RcppExports.R b/R/RcppExports.R
@@ -1,4 +1,4 @@
-# This file was generated by Rcpp::compileAttributes
+# Generated by using Rcpp::compileAttributes() -> do not edit by hand
 # Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
 
 #' @title Generate Random Wishart Distribution
@@ -26,7 +26,7 @@
 #' stopifnot(all.equal(vR, Va, tolerance = 1/16))
 #' 
 rwishart <- function(df, S) {
-    .Call('r2arma_rwishart', PACKAGE = 'r2arma', df, S)
+    .Call('_r2arma_rwishart', PACKAGE = 'r2arma', df, S)
 }
 
 #' @title Generate Random Inverse Wishart Distribution
@@ -40,7 +40,7 @@ rwishart <- function(df, S) {
 #' #Call with the following data:
 #' riwishart(3, diag(2))
 riwishart <- function(df, S) {
-    .Call('r2arma_riwishart', PACKAGE = 'r2arma', df, S)
+    .Call('_r2arma_riwishart', PACKAGE = 'r2arma', df, S)
 }
 
 #' Subset Non-connected Regions
@@ -65,7 +65,7 @@ riwishart <- function(df, S) {
 #' # Subset with Armadillo
 #' get_elements(m, row_index - 1, col_index - 1)
 get_elements <- function(x, row_ind, col_ind) {
-    .Call('r2arma_get_elements', PACKAGE = 'r2arma', x, row_ind, col_ind)
+    .Call('_r2arma_get_elements', PACKAGE = 'r2arma', x, row_ind, col_ind)
 }
 
 #' Reverse Subset Column
@@ -83,7 +83,7 @@ get_elements <- function(x, row_ind, col_ind) {
 #' x = matrix(c(1,2,3,4), nrow = 2,byrow = TRUE)
 #' rev_col_subset(x, 1, 0)
 rev_col_subset <- function(x, start, end) {
-    .Call('r2arma_rev_col_subset', PACKAGE = 'r2arma', x, start, end)
+    .Call('_r2arma_rev_col_subset', PACKAGE = 'r2arma', x, start, end)
 }
 
 #' Reverse Subset Row
@@ -100,7 +100,7 @@ rev_col_subset <- function(x, start, end) {
 #' x = matrix(c(1,2,3,4), nrow=2,byrow=TRUE)
 #' rev_row_subset(x, 1, 0)
 rev_row_subset <- function(x, start, end) {
-    .Call('r2arma_rev_row_subset', PACKAGE = 'r2arma', x, start, end)
+    .Call('_r2arma_rev_row_subset', PACKAGE = 'r2arma', x, start, end)
 }
 
 #' Reverse Armadillo Vector
@@ -114,7 +114,7 @@ rev_row_subset <- function(x, start, end) {
 #' x = 1:5
 #' reverse_vec(x)
 reverse_vec <- function(x) {
-    .Call('r2arma_reverse_vec', PACKAGE = 'r2arma', x)
+    .Call('_r2arma_reverse_vec', PACKAGE = 'r2arma', x)
 }
 
 #' Transform an Armadillo field<vec> to a matrix
@@ -124,7 +124,7 @@ reverse_vec <- function(x) {
 #' @return A \code{mat} containing the field elements within a column.
 #' @author JJB
 field_to_matrix <- function(x) {
-    .Call('r2arma_field_to_matrix', PACKAGE = 'r2arma', x)
+    .Call('_r2arma_field_to_matrix', PACKAGE = 'r2arma', x)
 }
 
 #' Accumulation of Armadillo field<vec>
@@ -134,7 +134,7 @@ field_to_matrix <- function(x) {
 #' @return An \code{mat} containing the field elements within a column.
 #' @author JJB
 sum_field_vec <- function(x) {
-    .Call('r2arma_sum_field_vec', PACKAGE = 'r2arma', x)
+    .Call('_r2arma_sum_field_vec', PACKAGE = 'r2arma', x)
 }
 
 #' @title Generate an integer sequence of values
@@ -151,7 +151,7 @@ sum_field_vec <- function(x) {
 #' seq_int(3, 5)
 #' seq_int(5, 3)
 seq_int <- function(a, b) {
-    .Call('r2arma_seq_int', PACKAGE = 'r2arma', a, b)
+    .Call('_r2arma_seq_int', PACKAGE = 'r2arma', a, b)
 }
 
 #' @title Generate a sequence of values ranging from a to b given a fixed amount of points.
@@ -169,7 +169,7 @@ seq_int <- function(a, b) {
 #' seq_default(1, 2, 10)
 #' seq_default(2, 1, 10)
 seq_default <- function(from, to, length_out) {
-    .Call('r2arma_seq_default', PACKAGE = 'r2arma', from, to, length_out)
+    .Call('_r2arma_seq_default', PACKAGE = 'r2arma', from, to, length_out)
 }
 
 #' @title Generate a sequence of values ranging from -a to a given a fixed amount of points.
@@ -184,7 +184,7 @@ seq_default <- function(from, to, length_out) {
 #' seq_default_a(1, 10)
 #' seq_default_a(1, 10)
 seq_default_a <- function(a, length_out) {
-    .Call('r2arma_seq_default_a', PACKAGE = 'r2arma', a, length_out)
+    .Call('_r2arma_seq_default_a', PACKAGE = 'r2arma', a, length_out)
 }
 
 #' @title Generate a sequence of values ranging from vector start to vector end
@@ -200,7 +200,7 @@ seq_default_a <- function(a, length_out) {
 #' seq_along_cpp(1:10)
 #' seq_along_cpp(5:10)
 seq_along_cpp <- function(along_with) {
-    .Call('r2arma_seq_along_cpp', PACKAGE = 'r2arma', along_with)
+    .Call('_r2arma_seq_along_cpp', PACKAGE = 'r2arma', along_with)
 }
 
 #' @title Generate a sequence of values ranging from 0 to n-1
@@ -216,7 +216,7 @@ seq_along_cpp <- function(along_with) {
 #' seq_len_cpp(2)
 #' seq_len_cpp(4)
 seq_len_cpp <- function(length_out) {
-    .Call('r2arma_seq_len_cpp', PACKAGE = 'r2arma', length_out)
+    .Call('_r2arma_seq_len_cpp', PACKAGE = 'r2arma', length_out)
 }
 
 #' @title Lagged Differences in Armadillo
@@ -230,7 +230,7 @@ seq_len_cpp <- function(length_out) {
 #' x = rnorm(10000, 0, 1)
 #' diff_cpp(x,1,1)
 diff_cpp <- function(x, lag, differences) {
-    .Call('r2arma_diff_cpp', PACKAGE = 'r2arma', x, lag, differences)
+    .Call('_r2arma_diff_cpp', PACKAGE = 'r2arma', x, lag, differences)
 }
 
 #' @title Converting an ARMA Process to an Infinite MA Process
@@ -247,7 +247,7 @@ diff_cpp <- function(x, lag, differences) {
 #' # ARMA(0,1)
 #' ARMAtoMA_cpp(numeric(0), 1.0, 10)
 ARMAtoMA_cpp <- function(ar, ma, lag_max) {
-    .Call('r2arma_ARMAtoMA_cpp', PACKAGE = 'r2arma', ar, ma, lag_max)
+    .Call('_r2arma_ARMAtoMA_cpp', PACKAGE = 'r2arma', ar, ma, lag_max)
 }
 
 #' @title Time Series Convolution Filters
@@ -275,7 +275,7 @@ ARMAtoMA_cpp <- function(ar, ma, lag_max) {
 #' # Using R's function
 #' filter(x, rep(1, 3), sides = 1, circular = TRUE)
 cfilter <- function(x, filter, sides, circular) {
-    .Call('r2arma_cfilter', PACKAGE = 'r2arma', x, filter, sides, circular)
+    .Call('_r2arma_cfilter', PACKAGE = 'r2arma', x, filter, sides, circular)
 }
 
 #' @title Time Series Recursive Filters
@@ -296,7 +296,7 @@ cfilter <- function(x, filter, sides, circular) {
 #' # Using R's function
 #' filter(x, rep(1, 3), method="recursive", init=rep(1, 3))
 rfilter <- function(x, filter, init) {
-    .Call('r2arma_rfilter', PACKAGE = 'r2arma', x, filter, init)
+    .Call('_r2arma_rfilter', PACKAGE = 'r2arma', x, filter, init)
 }
 
 #' @title Compute Theoretical ACF for an ARMA Process
@@ -314,7 +314,7 @@ rfilter <- function(x, filter, init) {
 #' # ARMA(0,1)
 #' ARMAacf_cpp(numeric(0), .35, lag_max = 10)
 ARMAacf_cpp <- function(ar, ma, lag_max) {
-    .Call('r2arma_ARMAacf_cpp', PACKAGE = 'r2arma', ar, ma, lag_max)
+    .Call('_r2arma_ARMAacf_cpp', PACKAGE = 'r2arma', ar, ma, lag_max)
 }
 
 #' @title Discrete Fourier Transformation for Autocovariance Function
@@ -329,6 +329,6 @@ ARMAacf_cpp <- function(ar, ma, lag_max) {
 #' x=rnorm(100)
 #' dft_acf(x)
 dft_acf <- function(x) {
-    .Call('r2arma_dft_acf', PACKAGE = 'r2arma', x)
+    .Call('_r2arma_dft_acf', PACKAGE = 'r2arma', x)
 }
 
diff --git a/man/ARMAacf_cpp.Rd b/man/ARMAacf_cpp.Rd
diff --git a/man/ARMAtoMA_cpp.Rd b/man/ARMAtoMA_cpp.Rd
diff --git a/man/cfilter.Rd b/man/cfilter.Rd
diff --git a/man/dft_acf.Rd b/man/dft_acf.Rd
diff --git a/man/diff_cpp.Rd b/man/diff_cpp.Rd
diff --git a/man/field_to_matrix.Rd b/man/field_to_matrix.Rd
diff --git a/man/get_elements.Rd b/man/get_elements.Rd
diff --git a/man/r2arma-package.Rd b/man/r2arma-package.Rd
diff --git a/man/rev_col_subset.Rd b/man/rev_col_subset.Rd
diff --git a/man/rev_row_subset.Rd b/man/rev_row_subset.Rd
diff --git a/man/reverse_vec.Rd b/man/reverse_vec.Rd
diff --git a/man/rfilter.Rd b/man/rfilter.Rd
diff --git a/man/riwishart.Rd b/man/riwishart.Rd
diff --git a/man/rwishart.Rd b/man/rwishart.Rd
diff --git a/man/seq_along_cpp.Rd b/man/seq_along_cpp.Rd
diff --git a/man/seq_default.Rd b/man/seq_default.Rd
diff --git a/man/seq_default_a.Rd b/man/seq_default_a.Rd
diff --git a/man/seq_int.Rd b/man/seq_int.Rd
diff --git a/man/seq_len_cpp.Rd b/man/seq_len_cpp.Rd
diff --git a/man/sum_field_vec.Rd b/man/sum_field_vec.Rd