Description Usage Arguments Details Value Examples

This function is a wrapper for `compare.vectors`

. It creates a Markdown report of all degrees of set comparisons between a named list of vectors.

1 2 3 4 5 6 7 8 | ```
compare.vectors.and.return.text.analysis.of.overlap(named_list_of_vectors_to_compare,
degrees_of_comparison_to_include = NULL, cat_immediately = FALSE,
draw_venn_diagrams = FALSE, viewport_npc_width_height_for_images = 1,
vector_colors_for_venn_diagrams = NULL, save_venn_diagram_files = FALSE,
location_for_venn_diagram_files = "", prefix_for_venn_diagram_files = "",
saved_venn_diagram_resolution_ppi = 300,
saved_venn_diagram_dimension_units = "in", saved_venn_diagram_width = 8,
saved_venn_diagram_height = 6, base_heading_level_to_use = 1)
``` |

`named_list_of_vectors_to_compare` |
A named list of vectors to compare (see, for example, |

`degrees_of_comparison_to_include` |
A number or vector of numbers of which degrees of comparison to print (for example, 'c(2, 5)' would print only 2- and 5-way vector comparisons). |

`cat_immediately` |
A logical (TRUE/FALSE) indicator whether to immediately print the output, as in an RMarkdown document. |

`draw_venn_diagrams` |
A logical (TRUE/FALSE) indicator whether to draw Venn diagrams for all 2- through 5-way comparisons of vectors. |

`viewport_npc_width_height_for_images` |
The scale at which to print an image. If the image is cut off at its edges, for example, this can be set lower than 1.0. |

`vector_colors_for_venn_diagrams` |
An optional vector of color names for Venn diagrams (if |

`save_venn_diagram_files` |
A logical (TRUE/FALSE) indicator whether to save Venn diagrams as PNG files. |

`location_for_venn_diagram_files` |
An optional string giving a directory into which to save Venn diagram PNG files (if |

`prefix_for_venn_diagram_files` |
An optional string giving a prefix to prepend to saved Venn diagram PNG files (if |

`saved_venn_diagram_resolution_ppi` |
An optional number giving a resolution (PPI) for saved Venn diagrams (if |

`saved_venn_diagram_dimension_units` |
An optional string giving units for specifying |

`saved_venn_diagram_width` |
The width (in |

`saved_venn_diagram_height` |
The height (in |

`base_heading_level_to_use` |
An integer indicating the highest-level heading to print. Defaults to |

Use of this function is illustrated with the `Veccompare Overlap Report`

RMarkdown template for RStudio that is installed as part of the veccompare package.

A string of Markdown (and Venn diagrams, if `draw_venn_diagrams`

is `TRUE`

).

If `cat_immediately`

is `TRUE`

, nothing is returned by the function; rather, the output Markdown is printed immediately (for example, as part of a Knitted RMarkdown document, or to the console).

If `cat_immediately`

is `FALSE`

, the output can be saved to an object (as in the example below). This object can then be printed using `cat()`

.

NOTE WELL: If `cat_immediately`

is `FALSE`

, the output *should* be saved to an object. If it is not, R will give an error message when printing to the console, because of unescaped special characters (which work correctly when `cat()`

is used).

1 2 3 4 5 6 | ```
example <- compare.vectors.and.return.text.analysis.of.overlap(
veccompare::example.vectors.list,
cat_immediately = FALSE,
draw_venn_diagrams = FALSE
)
cat(example)
``` |

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.