Add return values

R/data.R

@@ -3,5 +3,5 @@
 #' A list of wire cuts data set by subsampling factor 10 of the original wire cuts x3p.
 #'
 #' @format list
-#' A list of x3p objects
+#' A list of x3p objects named with surface scan names
 "x3p_subsamples"

R/df_rmtrend_x3p.R

@@ -4,6 +4,7 @@
 #' @param x3p x3p object
 #' @param mask_col colour for the polygon
 #' @param concavity strictly positive value used in \code{concaveman::concaveman}
+#' @return x3p object of residuals after removing trend
 #' @import dplyr
 #' @importFrom x3ptools df_to_x3p
 #' @importFrom stats lm predict

R/vec_align_sigs_list.R

@@ -9,6 +9,7 @@
 #' @param name2 name for the second cut
 #' @param legendname legend name
 #' @param titlename title name
+#' @return list of aligned signals named \code{ccf}, \code{lag} and \code{lands} followed the output format of \code{bulletxtrctr::sig_align}
 #' @importFrom ggplot2 ggplot aes geom_line labs xlab ggtitle
 #' @importFrom bulletxtrctr sig_align
 #' @export

R/x3p_MLE_angle_vec.R

@@ -6,6 +6,7 @@
 #' @param min_score_cut the tuning parameter for minimum scores required in hough transformation
 #' @param ifplot whether graphs are displayed
 #' @param loess_span the parameter which controls the degree of smoothing
+#' @return vector of rotation angles computed by MLE procedure
 #' @import dplyr
 #' @importFrom ggplot2 ggplot geom_histogram geom_point geom_smooth
 #' @importFrom raster raster

R/x3p_image_autosize.R

@@ -5,6 +5,7 @@
 #' @param ifhtml logical, whether the image will be put on html
 #' @param zoom numeric value indicating the amount of zoom
 #' @param ... other parameter values except size and zoom used in \code{x3ptools::x3p_image}
+#' @return rgl plot, list of tags when \code{ifhtml = TRUE}
 #' @importFrom x3ptools x3p_image
 #' @importFrom rgl rglwidget
 #' @importFrom htmltools tagList

R/x3p_impute.R

@@ -7,6 +7,7 @@
 #' @param ifsave whether the imputation procedure gif is going to be saved
 #' @param dir_name required when \code{ifsave} is \code{TRUE}
 #' @param ifplot whether graphs are displayed
+#' @return x3p obeject after imputation
 #' @import dplyr
 #' @importFrom x3ptools x3p_delete_mask x3p_extract x3p_average x3p_add_mask
 #' @importFrom ggplot2 ggplot aes geom_raster scale_fill_gradient2 labs ggsave

R/x3p_insidepoly_df.R

@@ -4,6 +4,7 @@
 #' @param x3p x3p object
 #' @param mask_col colour for the polygon
 #' @param concavity strictly positive value used in \code{concaveman::concaveman}
+#' @return data frame of inside polygon
 #' @import dplyr
 #' @importFrom x3ptools x3p_extract x3p_average x3p_to_df
 #' @importFrom tidyr pivot_longer

R/x3p_quantile_angle_vec.R

@@ -5,6 +5,7 @@
 #' @param ntheta number of bins along theta used in \code{imager::hough_line}
 #' @param min_score_cut the tuning parameter for minimum scores required in hough transformation
 #' @param ifplot whether graphs are displayed
+#' @return vector of rotation angles computed by quantile procedure
 #' @import dplyr
 #' @importFrom ggplot2 ggplot aes geom_histogram geom_point
 #' @importFrom raster raster

R/x3p_raw_sig_vec.R

@@ -4,6 +4,7 @@
 #' @param x3p x3p object
 #' @param method choice of \code{median} or \code{mean} when computing the summary statistics
 #' @param ifplot whether graphs are displayed
+#' @return vector of raw signal extracted
 #' @import dplyr
 #' @importFrom x3ptools x3p_to_df
 #' @importFrom ggplot2 ggplot aes geom_line

R/x3p_shift_sig_vec.R

@@ -5,6 +5,7 @@
 #' @param method choice of \code{median} or \code{mean} when computing the summary statistics
 #' @param ifplot whether graphs are displayed
 #' @param delta shifting range when minimizing MSE
+#' @return vector of shifted signals
 #' @import dplyr
 #' @importFrom x3ptools x3p_to_df x3p_delete_mask x3p_bin_stripes
 #' @importFrom ggplot2 ggplot aes geom_line geom_point

R/x3p_vertical.R

@@ -8,6 +8,7 @@
 #' @param min_score_cut the tuning parameter for minimum scores required in hough transformation
 #' @param ifplot whether graphs are displayed
 #' @param loess_span the parameter which controls the degree of smoothing, only available when \code{method = MLE}
+#' @return x3p object after rotation with vertical striations
 #' @import dplyr
 #' @importFrom x3ptools x3p_bin_stripes x3p_extract x3p_rotate
 #' @export