Skip to content

Commit

Permalink
Changed title after feedback from E.Hsieh
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian Buller, PhD, MA committed Oct 27, 2020
1 parent 253d770 commit 4807a2e
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: gateR
Type: Package
Title: Gating Strategy for Mass and Flow Cytometry using Spatial Kernel Density Estimation
Title: Statistical Gating Application for Flow and Mass Cytometry Analysis via Spatial Kernel Density Estimation
Version: 0.1.0.9000
Date: 2020-10-27
Authors@R:
Expand Down
2 changes: 1 addition & 1 deletion R/package.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' The gateR Package: Gating Strategy for Mass and Flow Cytometry using Spatial Kernel Density Estimation
#' The gateR Package: Statistical Gating Application for Flow and Mass Cytometry Analysis via Spatial Kernel Density Estimation
#'
#' Estimates statistically significant fluorescent marker combination values within which one immunologically distinctive group (i.e., disease case) is more associated than another group (i.e., healthy control), successively, using various combinations (i.e., "gates") of fluorescent markers to examine features of cells that may be different between groups.
#'
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
gateR: Gating Strategy for Mass and Flow Cytometry using Spatial Kernel Density Estimation <img src="dev/figures/gateR.png" width="120" align="right" />
gateR: Statistical Gating Application for Flow and Mass Cytometry Analysis via Spatial Kernel Density Estimation <img src="dev/figures/gateR.png" width="120" align="right" />
===================================================

<h2 id="overview">
Expand All @@ -7,7 +7,7 @@ Overview

</h2>

The `gateR` package is a suite of `R` functions to identify significant spatial clustering of mass cytometry data used in immunological investigations. For a two-group comparison we detect clusters using the kernel-based spatial relative risk function that is estimated using the [sparr](https://CRAN.R-project.org/package=sparr) package. The tests are conducted in two-dimensional space comprised of two fluorescent markers.
The `gateR` package is a suite of `R` functions to identify significant spatial clustering of flow and mass cytometry data used in immunological investigations. For a two-group comparison we detect clusters using the kernel-based spatial relative risk function that is estimated using the [sparr](https://CRAN.R-project.org/package=sparr) package. The tests are conducted in two-dimensional space comprised of two fluorescent markers.

Examples for a single condition:

Expand Down Expand Up @@ -56,7 +56,7 @@ Available functions
</thead>
<tbody>
<td><code>gating</code></td>
<td>Main function. Conduct a gating strategy for mass cytometry data.</td>
<td>Main function. Conduct a gating strategy for flow and mass cytometry data.</td>
</tr>
<td><code>rrs</code></td>
<td>Called within <code>gating</code>, one condition comparison.</td>
Expand Down
2 changes: 1 addition & 1 deletion man/gateR-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions vignettes/vignette.Rmd
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "gateR: Gating Strategy for Mass and Flow Cytometry using Spatial Kernel Density Estimation"
title: "gateR: Statistical Gating Application for Flow and Mass Cytometry Analysis via Spatial Kernel Density Estimation"
author: 'Ian D. Buller, Ph.D., M.A. (Github: @idblr)'
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{gateR: Gating Strategy for Mass and Flow Cytometry using Spatial Kernel Density Estimation}
%\VignetteIndexEntry{gateR: Statistical Gating Application for Flow and Mass Cytometry Analysis via Spatial Kernel Density Estimation}
%\VignetteEngine{R.rsp::asis}
%\VignetteEncoding{UTF-8}
---
Expand All @@ -13,7 +13,7 @@ vignette: >
knitr::opts_chunk$set(echo = TRUE, warning = FALSE, message = FALSE, cache = TRUE, fig.width = 7, fig.height = 7, fig.show = "hold")
```

The gateR package is a suite of R functions to identify significant spatial clustering of mass cytometry data used in immunological investigations. The gateR package can be used for a panel of all surface markers, or a mixture of surface markers and functional read outs. The gateR package performs a gating technique that estimates statistically significant fluorescent marker combination values within which one immunologically distinctive group (i.e., disease case) is more associated than another group (i.e., healthy control), successively, using various combinations (i.e., "gates") of fluorescent markers to examine features of cells that may be different between groups. For a two-group comparison, the gateR package uses the spatial relative risk function that is estimated using the [sparr](https://CRAN.R-project.org/package=sparr) package. The gates are conducted in two-dimensional space comprised of two fluorescent markers.
The gateR package is a suite of R functions to identify significant spatial clustering of mass and flow cytometry data used in immunological investigations. The gateR package can be used for a panel of all surface markers, or a mixture of surface markers and functional read outs. The gateR package performs a gating technique that estimates statistically significant fluorescent marker combination values within which one immunologically distinctive group (i.e., disease case) is more associated than another group (i.e., healthy control), successively, using various combinations (i.e., "gates") of fluorescent markers to examine features of cells that may be different between groups. For a two-group comparison, the gateR package uses the spatial relative risk function that is estimated using the [sparr](https://CRAN.R-project.org/package=sparr) package. The gates are conducted in two-dimensional space comprised of two fluorescent markers.

Examples of a single condition with two groups:

Expand Down
8 changes: 4 additions & 4 deletions vignettes/vignette.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion vignettes/vignette.html.asis
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
%\VignetteIndexEntry{gateR: Gating Strategy for Mass and Flow Cytometry using Spatial Kernel Density Estimation}
%\VignetteIndexEntry{gateR: Statistical Gating Application for Flow and Mass Cytometry Analysis via Spatial Kernel Density Estimation}
%\VignetteEngine{R.rsp::asis}
%\VignetteKeyword{gateR}

0 comments on commit 4807a2e

Please sign in to comment.