From a553200b91ae95f48a88e267839ed0bada5d2986 Mon Sep 17 00:00:00 2001
From: MikeDMorgan <michael.morgan@abdn.ac.uk>
Date: Wed, 8 Nov 2023 15:32:27 +0000
Subject: [PATCH] updated man pages

---
 man/plotNhoodGroups.Rd | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 man/plotNhoodGroups.Rd

diff --git a/man/plotNhoodGroups.Rd b/man/plotNhoodGroups.Rd
new file mode 100644
index 0000000..58f1e13
--- /dev/null
+++ b/man/plotNhoodGroups.Rd
@@ -0,0 +1,31 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotNhoods.R
+\name{plotNhoodGroups}
+\alias{plotNhoodGroups}
+\title{Plot graph of neighbourhoods coloring by nhoodGroups}
+\usage{
+plotNhoodGroups(x, milo_res, show_groups = NULL, ...)
+}
+\arguments{
+\item{x}{A \code{\linkS4class{Milo}} object}
+
+\item{milo_res}{a data.frame of milo results containing the \code{nhoodGroup} column}
+
+\item{show_groups}{a character vector indicating which groups to plot
+all other neighbourhoods will be gray}
+
+\item{...}{arguments to pass to \code{plotNhoodGraph}}
+}
+\value{
+a \code{ggplot} object
+}
+\description{
+Visualize grouping of neighbourhoods obtained with \code{groupNhoods}
+}
+\examples{
+NULL
+
+}
+\author{
+Emma Dann
+}