included citation in README and fixed DESCRIPTION

DESCRIPTION

@@ -2,8 +2,10 @@ Package: tubecleanR
 Type: Package
 Title: Parsing and Preprocessing YouTube Comment Data
 Version: 0.1.0
-Author: Julian Kohne; Johannes Breuer
-Maintainer: Julian Kohne <[email protected]>
+Date: 2024-02-26
+Authors@R: c(person("Julian", "Kohne", role = c("aut", "cre"), email = "[email protected]"),
+             person("Johannes", "Breuer", role = "aut", email = "[email protected]"))
+Maintainer: Julian Kohne <[email protected]>
 Description: This mini-package is mainly meant as extension for the tuber and the vosonSML packages for preprocessing comment collected via the YouTube API. The package processes YouTube comment data by removing and/or replacing links, emoticons, emoji, and user names. The output of the main function of this package is a well-defined dataframe suitable for further processing and (text) analysis.
 Imports: anytime, qdapRegex, stringi, utils
 License: CC BY-NC 4.0 + file LICENSE

README.md

@@ -42,3 +42,27 @@ View(Voson_parsed)
 The `parse_yt_comments()` function is meant to be used for *YouTube* comment data collected with the `get_all_comments()` function from `tuber` or the `Collect()` function from `vosonSML`. Both of those require access credentials for the *YouTube API*. Check the documentation of those two packages for further details.
 
 If you want to learn more about getting access to the *YouTube* API, collecting comment (and other) data from the API using `R`, and processing and exploring the resulting data, you can also check out the materials from our [workshop](https://github.com/jobreu/youtube-workshop-gesis-2023).
+
+## 4) Citation
+If you are using this package in your research, please cite it as follows:
+
+```R
+> citation("tubecleanR")
+```
+
+```R
+To cite package ‘tubecleanR’ in publications use:
+
+  Kohne, J., & Breuer, J. (2024). tubecleanR: Parsing and Preprocessing YouTube Comment
+  Data. R package version 0.1.0. <https://gesiscss.github.io/tubecleanR/>.
+
+A BibTeX entry for LaTeX users is
+
+  @Manual{,
+    title = {tubecleanR: Parsing and Preprocessing YouTube Comment Data},
+    author = {Julian Kohne and Johannes Breuer},
+    year = {2024},
+    note = {R package version 0.1.0},
+    url = {https://gesiscss.github.io/tubecleanR/},
+  }
+```

inst/CITATION

@@ -0,0 +1,10 @@
+citHeader("To cite package ‘tubecleanR’ in publications use:")
+
+citEntry(entry="Manual",
+         title="tubecleanR: Parsing and Preprocessing YouTube Comment Data",
+         author="Julian Kohne and Johannes Breuer",
+         year="2024",
+         note="R package version 0.1.0",
+         url="https://gesiscss.github.io/tubecleanR/",
+         textVersion="Kohne, J., & Breuer, J. (2024). tubecleanR: Parsing and Preprocessing YouTube Comment Data. R package version 0.1.0. <https://gesiscss.github.io/tubecleanR/>.")
+