{
  "name": "corrr functions and their documented defaults",
  "description": "Compiled from the corrr reference pages on corrr.tidymodels.org (correlate, focus, shave, rearrange, stretch, fashion, rplot, network_plot): each function's purpose, its key arguments with the defaults shown in the usage section, and what it returns. Defaults are as documented on the pkgdown reference pages on the date read.",
  "page": "https://casrai.org/guides/corrr",
  "publisher": "CASRAI",
  "license": "https://creativecommons.org/licenses/by/4.0/",
  "dateModified": "2026-11-22T08:20:00Z",
  "temporalCoverage": null,
  "spatialCoverage": null,
  "columns": [
    {
      "name": "Function",
      "unit": "",
      "description": ""
    },
    {
      "name": "Purpose",
      "unit": "",
      "description": ""
    },
    {
      "name": "Key arguments and defaults",
      "unit": "",
      "description": ""
    },
    {
      "name": "Returns",
      "unit": "",
      "description": ""
    }
  ],
  "rows": [
    {
      "Function": "correlate()",
      "Purpose": "Compute a correlation data frame, like cor()",
      "Key arguments and defaults": "use = \"pairwise.complete.obs\"; method = \"pearson\"; diagonal = NA; quiet = FALSE",
      "Returns": "cor_df (tibble with term column)"
    },
    {
      "Function": "focus()",
      "Purpose": "Keep chosen variables as columns and remove them or all others from rows",
      "Key arguments and defaults": "mirror = FALSE",
      "Returns": "tibble, or cor_df if mirror = TRUE"
    },
    {
      "Function": "shave()",
      "Purpose": "Set the upper or lower triangle to NA",
      "Key arguments and defaults": "upper = TRUE",
      "Returns": "cor_df"
    },
    {
      "Function": "rearrange()",
      "Purpose": "Group highly correlated variables together",
      "Key arguments and defaults": "method = \"PC\" (text says PCA); absolute = TRUE",
      "Returns": "cor_df"
    },
    {
      "Function": "stretch()",
      "Purpose": "Convert to long format (x, y, r)",
      "Key arguments and defaults": "na.rm = FALSE; remove.dups = FALSE",
      "Returns": "tibble with three columns"
    },
    {
      "Function": "fashion()",
      "Purpose": "Format a correlation data frame for printing",
      "Key arguments and defaults": "decimals = 2; leading_zeros = FALSE; na_print = \"\"",
      "Returns": "noquote matrix or data frame"
    },
    {
      "Function": "rplot()",
      "Purpose": "Plot correlations as sized, coloured points",
      "Key arguments and defaults": "legend = TRUE; shape = 16; print_cor = FALSE; .order = \"default\"",
      "Returns": "ggplot2 plot"
    },
    {
      "Function": "network_plot()",
      "Purpose": "Plot variables as a network joined by correlation paths",
      "Key arguments and defaults": "min_cor = 0.3; legend = \"full\"; repel = TRUE; curved = TRUE",
      "Returns": "ggplot2 plot"
    }
  ],
  "sources": [
    {
      "title": "corrr reference: correlate()",
      "url": "https://corrr.tidymodels.org/reference/correlate.html",
      "accessed": "2026-11-17"
    },
    {
      "title": "corrr reference: rearrange()",
      "url": "https://corrr.tidymodels.org/reference/rearrange.html",
      "accessed": "2026-11-17"
    },
    {
      "title": "corrr reference: network_plot()",
      "url": "https://corrr.tidymodels.org/reference/network_plot.html",
      "accessed": "2026-11-17"
    },
    {
      "title": "corrr reference: fashion()",
      "url": "https://corrr.tidymodels.org/reference/fashion.html",
      "accessed": "2026-11-17"
    }
  ]
}