Merge pull request #166 from umccr/add-citation

Initialise citation file
umccr · Sep 12, 2024 · 0a5abfb · 0a5abfb
2 parents bf35b42 + a8ebcd1
commit 0a5abfb
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 0 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -368,3 +368,23 @@ that are presented in the HTML report.
 #### Code of Conduct
 
 The code of conduct can be accessed [here](./CODE_OF_CONDUCT.md).
+
+#### Citation
+
+To cite package ‘RNAsum’ in publications use:
+
+  > Kanwal S, Marzec J, Diakumis P, Hofmann O, Grimmond S (2024). “RNAsum: An R
+  package to comprehensively post-process, summarise and visualise genomics and
+  transcriptomics data.” version 1.1.0, <https://umccr.github.io/RNAsum/>.
+
+A BibTeX entry for LaTeX users is
+
+```
+  @Unpublished{,
+    title = {RNAsum: An R package to comprehensively post-process, summarise and visualise genomics and transcriptomics data},
+    author = {Sehrish Kanwal and Jacek Marzec and Peter Diakumis and Oliver Hofmann and Sean Grimmond},
+    year = {2024},
+    note = {version 1.1.0},
+    url = {https://umccr.github.io/RNAsum/},
+  }
+```
diff --git a/README.md b/README.md
@@ -465,3 +465,22 @@ tables that are presented in the HTML report.
 #### Code of Conduct
 
 The code of conduct can be accessed [here](./CODE_OF_CONDUCT.md).
+
+#### Citation
+
+To cite package ‘RNAsum’ in publications use:
+
+> Kanwal S, Marzec J, Diakumis P, Hofmann O, Grimmond S (2024). “RNAsum:
+> An R package to comprehensively post-process, summarise and visualise
+> genomics and transcriptomics data.” version 1.1.0,
+> <https://umccr.github.io/RNAsum/>.
+
+A BibTeX entry for LaTeX users is
+
+      @Unpublished{,
+        title = {RNAsum: An R package to comprehensively post-process, summarise and visualise genomics and transcriptomics data},
+        author = {Sehrish Kanwal and Jacek Marzec and Peter Diakumis and Oliver Hofmann and Sean Grimmond},
+        year = {2024},
+        note = {version 1.1.0},
+        url = {https://umccr.github.io/RNAsum/},
+      }
diff --git a/inst/CITATION b/inst/CITATION
@@ -0,0 +1,8 @@
+bibentry(
+  bibtype  = "Unpublished",
+  title    = "RNAsum: An R package to comprehensively post-process, summarise and visualise genomics and transcriptomics data",
+  author   = "Sehrish Kanwal, Jacek Marzec, Peter Diakumis, Oliver Hofmann, Sean Grimmond",
+  year     = 2024,
+  note     = "version 1.1.0",
+  url      = "https://umccr.github.io/RNAsum/"
+)