Skip to contents

Querries reference signatures and returns most similar fluorophores by cosine similarity.

Usage

QC_WhatsThis(
  x,
  columnname = "Sample",
  data,
  NumberHits,
  NumberDetectors = NULL,
  Normalize = TRUE,
  returnPlots = FALSE,
  TheFormat = "wider",
  detectorcolumn = NULL,
  valuecolumn = NULL,
  plotlinecolor = NULL
)

Arguments

x

Name in the Sample column you want to filter for

columnname

Designating column to filter the x argument from

data

A data.frame object from QC_LibraryParse containing Fluorophore name column and numeric detector columns.

NumberHits

Number of most similar fluorophores by cosine.

NumberDetectors

Default NULL, estimated from number of numeric columns in passed data.

Normalize

Default TRUE, needed for ReferenceLibrary comparison.

returnPlots

Whether to return signature plots, default is set to FALSE.

TheFormat

Default wider for detectors in columns, specify longer if providing detectors as rows

detectorcolumn

Default NULL, when TheFormat="longer" specify detector column name

valuecolumn

Default NULL, when TheFormat="longer" specify value column name

plotlinecolor

Default NULL, otherwise if single line provide desired color

Value

A dataframe of similar fluorophores or a ggplot2 object

Examples

library(dplyr)
Folder_Location <- system.file("extdata", package = "Luciernaga")
XML_Pattern <- ".XML$"
XML_Files <- list.files(path = Folder_Location, pattern = XML_Pattern,
                        full.names = TRUE, recursive = FALSE)
Data <- QC_LibraryParse(XML_Files[2], returntype="data", references=FALSE)
TheFluorophore <- Data |> pull(Sample)

Results <- QC_WhatsThis(x=TheFluorophore, columnname="Sample", data=Data, NumberHits = 10, returnPlots=FALSE)
#> Combining character columns
#> Normalizing Data for Signature Comparison