fix bug commenting out examples in documentation

Author: halleeshearer

R/create_plots.R

@@ -20,7 +20,7 @@
 #' @export
 #'
 #' @examples
-#' Example usage
+#' # Example usage
 #' create_plots(pd)
 create_plots <- function(plot_data_list, plot_type = 'simci', effect_type = 'd', do_multivariate = FALSE, add_description = FALSE, do_minimal_title = FALSE, summary_info = NULL) {
 

R/meta_analysis.R

@@ -13,7 +13,7 @@
 #' @export
 #'
 #' @examples
-#' Example usage
+#' # Example usage
 #' meta_analysis(v,v$brain_masks, "pooling.none.motion.none.mv.none")
 meta_analysis <- function(v, brain_masks, combo_name, grouping_var = "category") {
 

R/plot_helpers.R

@@ -41,7 +41,7 @@
 #' @export
 #'
 #' @examples
-#' Example usage
+#' # Example usage
 #' plot_simci_panel(plot_data)
 plot_simci_panel <- function(pp, plot_data_list) {
 
@@ -135,7 +135,7 @@ plot_simci_panel <- function(pp, plot_data_list) {
 #' @export
 #'
 #' @examples
-#' Example usage
+#' # Example usage
 #' plot_density_panel(plot_data)
 plot_density_panel <- function(pp, plot_data_list, use_effect_size_bin = FALSE) {
 
@@ -304,7 +304,7 @@ plot_density_panel <- function(pp, plot_data_list, use_effect_size_bin = FALSE)
 #' @export
 #'
 #' @examples
-#' Example usage
+#' # Example usage
 #' plot_activation_maps(plot_data)
 plot_activation_panel <- function(pp, plot_data_list, threshold_category = NA) {
 
@@ -549,7 +549,7 @@ colorbar_custom <- function(breaks, #the minimum and maximum z values for which
 #' @export
 #'
 #' @examples
-#' Example usage
+#' # Example usage
 #' plot_connectivity_panel(plot_data)
 plot_connectivity_panel <- function(pp, plot_data_list, threshold_category = NA) {
 
@@ -1016,7 +1016,7 @@ plot_power_panel <- function(pp, plot_data_list, output_type, use_category_bins
 #' @export
 #'
 #' @examples
-#' Example usage
+#' # Example usage
 #' get_summary_info(pp, study_details, extra_study_details)
 get_summary_info <- function(study_details, extra_study_details) {
 
@@ -1118,7 +1118,7 @@ combine_summary_info <- function(summary_info) {
 #' @export
 #'
 #' @examples
-#' Example usage
+#' # Example usage
 #' add_plot_description(p, pp, study_details, extra_study_details)
 add_plot_description <- function(p, pp, summary_info, add_extra_text, do_minimal_title) {
 

R/prep_data_for_plot.R

@@ -15,7 +15,7 @@
 #' @export
 #'
 #' @examples
-#' Example usage
+#' # Example usage
 #' pd <- prep_data_for_plot(data = v$data[[i]], study_details = v$study[i, ], 
 #' plot_info$grouping_var='none', 
 #' combo_name = "pooling.none.motion.none.mv.none", 

R/prep_data_for_spatial_plot.R

@@ -15,7 +15,7 @@
 #' @export
 #'
 #' @examples
-#' Example usage
+#' # Example usage
 #' pd <- prep_data_for_spatial_plot(data = v$data[[i]], 
 #' study_details = v$study[i, ], plot_info$grouping_var='none',
 #' combo_name = "pooling.none.motion.none.mv.none",