Merge pull request #100 from IndrajeetPatil/citation

add citation file

README.Rmd

@@ -31,14 +31,27 @@ interest which itself is annotated with the level of significance (NS, \*, \*\*,
 groups for comparison and the test (t.test, wilcox etc.) and adds the annotation
 to the plot.
 
+## Citation
+
+If you wish to cite this package in a publication, you can run the following
+command in your R console:
+
+```{r citation}
+citation("ggsignif")
+```
+
 ## Example
 
-Install package
+You can first install this package from `CRAN`:
 
 ```{r eval=FALSE}
 install.packages("ggsignif")
+```
+
+Or get the latest development version:
 
-# Or for the latest development version
+```{r eval=FALSE}
+install.packages("remotes")
 remotes::install_github("const-ae/ggsignif")
 ```
 

README.md

@@ -20,14 +20,44 @@ level of significance (NS, \*, \*\*, \*\*\*). The package provides a
 single layer (`geom_signif`) that takes the groups for comparison and
 the test (t.test, wilcox etc.) and adds the annotation to the plot.
 
+## Citation
+
+If you wish to cite this package in a publication, you can run the
+following command in your R console:
+
+``` r
+citation("ggsignif")
+#> 
+#> To cite 'ggsignif' in publications use:
+#> 
+#>   Ahlmann-Eltze, C., & Patil, I. (2021). ggsignif: R Package for
+#>   Displaying Significance Brackets for 'ggplot2'. PsyArxiv.
+#>   doi:10.31234/osf.io/7awm6
+#> 
+#> A BibTeX entry for LaTeX users is
+#> 
+#>   @Article{,
+#>     title = {{ggsignif}: R Package for Displaying Significance Brackets for {'ggplot2'}},
+#>     author = {Ahlmann-Eltze Constantin and Indrajeet Patil},
+#>     year = {2021},
+#>     journal = {PsyArxiv},
+#>     url = {https://psyarxiv.com/7awm6},
+#>     doi = {10.31234/osf.io/7awm6},
+#>   }
+```
+
 ## Example
 
-Install package
+You can first install this package from `CRAN`:
 
 ``` r
 install.packages("ggsignif")
+```
 
-# Or for the latest development version
+Or get the latest development version:
+
+``` r
+install.packages("remotes")
 remotes::install_github("const-ae/ggsignif")
 ```
 

inst/CITATION

@@ -0,0 +1,12 @@
+citHeader("To cite 'ggsignif' in publications use:")
+
+citEntry(
+  entry    = "Article",
+  title    = "{ggsignif}: R Package for Displaying Significance Brackets for {'ggplot2'}",
+  author   = c(person("Ahlmann-Eltze", "Constantin"), person("Indrajeet", "Patil")),
+  year     = 2021,
+  journal  = "PsyArxiv",
+  url      = "https://psyarxiv.com/7awm6",
+  doi      = "10.31234/osf.io/7awm6",
+textVersion = "Ahlmann-Eltze, C., & Patil, I. (2021). ggsignif: R Package for Displaying Significance Brackets for 'ggplot2'. PsyArxiv. doi:10.31234/osf.io/7awm6"
+)

inst/WORDLIST

@@ -1,13 +1,25 @@
+Ahlmann
 Codecov
+Eltze
+ORCID
 README
+ae
 behaviour
+const
 ggplot
 ggplots
+github
+https
+io
+lifecycle
 linetype
 md
+multiway
+patilindrajeets
 plotmath
 signif
 textsize
 wilcox
 xmax
 xmin
+’