Final changes to documentation before release

DESCRIPTION

@@ -1,11 +1,12 @@
 Package: rwhatsapp
-Title: Working with WhatsApp data
-Version: 0.1.5.9000
-Date: 2019-09-14
-Authors@R: person("Johannes", "Gruber", email = "[email protected]", 
+Title: Import and Handling for 'WhatsApp' Chat Logs
+Version: 0.2.0
+Date: 2019-09-15
+Authors@R: person("Johannes", "Gruber", email = "[email protected]",
   role = c("aut", "cre"))
-Description: A straightforward parsing package which digests history files from
-    the popular messenger service "WhatsApp" in all locales and from all devices.
+Description: A straightforward, easy-to-use and robust parsing package which digests
+    history files from the popular messenger service 'WhatsApp' in all locales and
+    from all devices.
 Depends:
     R (>= 3.4.0)
 License: GPL-3

R/rwhatsapp.R

@@ -1,7 +1,10 @@
 #' Read WhatsApp history into R
 #'
-#' The history can be obtained going to the menu in a chat on the WhatsApp app,
-#' choosing "more", then "Export chat".
+#' Takes a history file from the ``WhatsApp'' messenger app and returns a
+#' formatted data.frame with descriptions of the used emojis.
+#'
+#' @details The history can be obtained going to the menu in a chat on the
+#'   ``WhatsApp'' app, choosing "more", then "Export chat".
 #'
 #' @param x Path to a txt or zip file of a WhatsApp history or the history
 #'   itself as character object.
@@ -15,7 +18,7 @@
 #'   printed to the screen.
 #' @param ... Further arguments passed to \link[stringi]{stri_read_lines}.
 #'
-#' @return a tibble
+#' @return A tibble with the information parsed from the history file.
 #' @export
 #' @import stringi
 #' @importFrom tibble tibble
@@ -332,8 +335,10 @@ f_exist_s <- function(x) {
 #' A dataset containing emojis and corresponding descriptions. This is a subset
 #' of the emojis provided by the emo package.
 #'
-#' @format A tibble with 3570 rows and 2 columns
-#' - emoji: character representation of the emoji
-#' - name: name of the emoji
+#' @format A tibble with 3570 rows and 2 columns:
+#' \itemize{
+#'   \item emoji: character representation of the emoji
+#'   \item name of the emoji
+#' }
 #' @source \url{https://github.com/hadley/emo/}
 "emojis"

README.md

@@ -25,7 +25,7 @@ capabilities. Furthermore, retrieving chat logs from the Android or iOS
 app is very straightforward: Simply choose `More` in the menu of a chat,
 then `Export chat` and export the history to a txt file.
 
-<img src="https://i.imgur.com/9pZjPFC.jpg" width="200" /> <img src="https://i.imgur.com/OwUE6aE.jpg" width="200" /> <img src="https://i.imgur.com/8lCJQfZ.jpg" width="200" />
+<img src="https://i.imgur.com/9pZjPFC.jpg" width="250" /> <img src="https://i.imgur.com/OwUE6aE.jpg" width="250" /> <img src="https://i.imgur.com/8lCJQfZ.jpg" width="250" />
 
 This package is intended make the first step of analysing WhatsApp text
 data as easy as possible—reading your chat history into `R`. This should