Update NEWS, spelling error, and wordlist

NEWS.md

@@ -1,5 +1,7 @@
 # miplicorn (development version)
 
+- Improve documentation by adding return values, rewriting examples, and
+  updating the README.
 - New `plot_coverage()` function can be used to plot the average coverage across
   a given grouping variable (#46).
 - The column created by `label_mutations()` has been renamed from

R/read-deprecated.R

@@ -12,10 +12,10 @@
 #'
 #' @details
 #' Read files containing
-#' \href{https://github.com/bailey-lab/MIPTools}{MIPtools'} data tables.
+#' \href{https://github.com/bailey-lab/MIPTools}{MIPTools'} data tables.
 #' `read_file()` reads a single file. `read()` is a convenience function that
 #' reads all files output by
-#' \href{https://github.com/bailey-lab/MIPTools}{MIPtools} and combines them.
+#' \href{https://github.com/bailey-lab/MIPTools}{MIPTools} and combines them.
 #' Data files include the reference table, the alternate table, and the coverage
 #' table. Data is read lazily using the
 #' \href{https://vroom.r-lib.org/index.html}{`vroom`} package. Data can be

inst/WORDLIST

@@ -1,85 +1,42 @@
-amplicon
 Amplicon
-args
-Aris
-arispas
-bootswatch
-bslib
-cderv
+amplicon
 CMD
-codecov
 Codecov
 colour
+coloured
 colours
-config
-covr
-csv
 dbplyr
-desc
-dir
 dplyr
 dtplyr
-env
-ENV
 erroring
 eval
 extdata
 falciparum
-faq
-Fira
+filepath
 ggplot
-gh
-github
 Github
-href
-http
-https
-io
-JamesIves
 karyoplot
-Lato
+karyoploteR
 Lifecycle
-macOS
 magrittr
-MERCHANTABILITY
 Metaprogramming
 MIP
 miplicorn
-MIPtools
 MIPTools
-monospace
+MIPtools
 NaN
-nav
-navbar
-NONINFRINGEMENT
-noreply
-oldrel
 ORCID
-os
-pandoc
-params
-Paschalidis
 pkgdown
 PlasmoDB
 Plasmodium
 pts
-px
-rcmdcheck
+README
 rect
-repo
-Reprex
 rlang
-Rscript
-rspm
 signalling
-sublicense
-tbl
-testthat
 tibble
-TMPDIR
 TSV
 tunnelled
 tunnelling
-ubuntu
+UMI
 umi
-www