Skip to content

Commit 8295295

Browse files
author
Ian Buller, PhD, MA
committedAug 8, 2022
Updated README
* Added badges, ORCIDs, funding, acknowledgements, and questions sections to README * ignore CRAN-SUBMISSIONS and figures in R build * Remove superfluous langauge in LICENSE
1 parent a7010be commit 8295295

File tree

4 files changed

+32
-24
lines changed

4 files changed

+32
-24
lines changed
 

‎.Rbuildignore

+2
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@
66
^dev$
77
^CRAN-RELEASE$
88
^data-raw$
9+
^CRAN-SUBMISSION$
10+
^man/figures

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,6 @@ rsconnect/
4242

4343
# R installed data
4444
*.rds
45+
46+
# CRAN
47+
CRAN-SUBMISSION

‎LICENSE.md

-10
Original file line numberDiff line numberDiff line change
@@ -169,16 +169,6 @@ accepting any such warranty or additional liability.
169169

170170
_END OF TERMS AND CONDITIONS_
171171

172-
### APPENDIX: How to apply the Apache License to your work
173-
174-
To apply the Apache License to your work, attach the following boilerplate
175-
notice, with the fields enclosed by brackets `[]` replaced with your own
176-
identifying information. (Don't include the brackets!) The text should be
177-
enclosed in the appropriate comment syntax for the file format. We also
178-
recommend that a file or class name and description of purpose be included on
179-
the same “printed page” as the copyright notice for easier identification within
180-
third-party archives.
181-
182172
Copyright 2020 Ian D. Buller; NCI
183173

184174
Licensed under the Apache License, Version 2.0 (the "License");

‎README.md

+27-14
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@ gateR: Flow/Mass Cytometry Gating via Spatial Kernel Density Estimation <img src
22
===================================================
33

44
<!-- badges: start -->
5-
6-
[![CRAN
7-
version](https://www.r-pkg.org/badges/version-ago/gateR)](https://cran.r-project.org/package=gateR)
8-
[![CRAN RStudio mirror
9-
downloads](https://cranlogs.r-pkg.org/badges/grand-total/gateR?color=blue)](https://r-pkg.org/pkg/gateR)
10-
![license](https://img.shields.io/badge/license-apache-yellow)
5+
[![CRAN status](http://www.r-pkg.org/badges/version/gateR)](https://cran.r-project.org/package=gateR)
6+
[![CRAN version](https://www.r-pkg.org/badges/version-ago/gateR)](https://cran.r-project.org/package=gateR)
7+
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/grand-total/gateR?color=blue)](https://r-pkg.org/pkg/gateR)
8+
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
9+
![GitHub last commit](https://img.shields.io/github/last-commit/Waller-SUSAN/gateR)
1110
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5347893.svg)](https://doi.org/10.5281/zenodo.5347893)
12-
1311
<!-- badges: end -->
1412

13+
**Date repository last updated**: August 08, 2022
14+
1515
<h2 id="overview">
1616

1717
Overview
@@ -32,7 +32,7 @@ For a two-group comparison of two conditions we estimate two relative risk surfa
3232
2. Condition 1B v. Condition 1A
3333
2. Estimate relative risk surface for the ratio:
3434

35-
![equation](https://latex.codecogs.com/gif.latex?%5Cfrac%7B%28%5Cfrac%7BCondtion2B%7D%7BCondition2A%7D%29%7D%7B%28%5Cfrac%7BCondition1B%7D%7BCondition1A%7D%29%7D)
35+
<img src="http://www.sciweavers.org/tex2img.php?eq=%5Cfrac%7B%20%5Cbig%28%5Cfrac%7BCondition2B%7D%7BCondition2A%7D%5Cbig%29%7D%7B%5Cbig%28%5Cfrac%7BCondition1B%7D%7BCondition1A%7D%5Cbig%29%7D&bc=White&fc=Black&im=jpg&fs=12&ff=arev&edit=0" align="center" border="0" alt="\frac{ \big(\frac{Condition2B}{Condition2A}\big)}{\big(\frac{Condition1B}{Condition1A}\big)}" width="100" height="58" />
3636

3737
Within areas where the relative risk exceeds an asymptotic normal assumption, the `gateR` package has functionality to examine the features of these cells. Basic visualization is also supported.
3838

@@ -119,15 +119,16 @@ Authors
119119

120120
</h2>
121121

122-
* **Ian D. Buller** - *Occupational and Environmental Epidemiology Branch, Division of Cancer Epidemiology and Genetics, National Cancer Institute, National Institutes of Health, Rockville, Maryland* - [GitHub](https://github.com/idblr)
122+
* **Ian D. Buller** - *Occupational and Environmental Epidemiology Branch, Division of Cancer Epidemiology and Genetics, National Cancer Institute, National Institutes of Health, Rockville, Maryland* - [GitHub](https://github.com/idblr) - [ORCID](https://orcid.org/0000-0001-9477-8582)
123123

124124
See also the list of [contributors](https://github.com/Waller-SUSAN/gateR/graphs/contributors) who participated in this project. Main contributors include:
125125

126-
* **Elena Hsieh** - *Immunology & Microbiology and Pediatrics, University of Colorado Anschutz School of Medicine* - [GitHub](https://github.com/elenahsieh1407)
127-
* **Debashis Ghosh** - *Biostatistics & Informatics, Colorado School of Public Health, Aurora, Colorado* - [GitHub](https://github.com/ghoshd)
128-
* **Lance A. Waller** - *Biostatistics and Bioinformatics, Emory University, Atlanta, Georgia* - [GitHub](https://github.com/lance-waller)
126+
* **Elena Hsieh** - *Immunology & Microbiology and Pediatrics, University of Colorado Anschutz School of Medicine* - [GitHub](https://github.com/elenahsieh1407) - [ORCID](https://orcid.org/0000-0003-3969-6597)
127+
* **Debashis Ghosh** - *Biostatistics & Informatics, Colorado School of Public Health, Aurora, Colorado* - [GitHub](https://github.com/ghoshd) - [ORCID](https://orcid.org/0000-0001-5672-7645)
128+
* **Lance A. Waller** - *Biostatistics and Bioinformatics, Emory University, Atlanta, Georgia* - [GitHub](https://github.com/lance-waller) - [ORCID](https://orcid.org/0000-0001-5002-8886)
129129

130130
## Usage
131+
131132
``` r
132133
set.seed(1234) # for reproducibility
133134

@@ -218,9 +219,7 @@ graphics::legend("topright",
218219
```
219220

220221
![](man/figures/gate1.png)
221-
222222
![](man/figures/gate2.png)
223-
224223
![](man/figures/postgate.png)
225224

226225
```r
@@ -248,3 +247,17 @@ test_rrs <- gateR::rrs(dat = obs_dat[ , -7:-6])
248247
## For "arcsinh_CD8" and "arcsinh_CD3"
249248
test_lotrrs <- gateR::lotrrs(dat = obs_dat[ , -5:-4])
250249
```
250+
251+
### Funding
252+
253+
This package was developed while the author was a doctoral student at in the [Environmental Health Sciences doctoral program](https://www.sph.emory.edu/departments/eh/degree-programs/phd/index.html) at [Emory University](https://www.emory.edu) and a postdoctoral fellow supported by the [Cancer Prevention Fellowship Program](https://cpfp.cancer.gov/) at the [National Cancer Institute](https://www.cancer.gov/).
254+
255+
### Acknowledgments
256+
257+
When citing this package for publication, please follow:
258+
259+
citation("gateR")
260+
261+
### Questions? Feedback?
262+
263+
For questions about the package please contact the maintainer [Dr. Ian D. Buller](mailto:ian.buller@nih.gov) or [submit a new issue](https://github.com/Waller-SUSAN/gateR/issues).

0 commit comments

Comments
 (0)
Please sign in to comment.