close #20 - rename get_lang to get_swearwords

pdrhlik · Sep 21, 2018 · d5bc68c · d5bc68c
1 parent eed8646
commit d5bc68c
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 11 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,3 +1,3 @@
 # Generated by roxygen2: do not edit by hand
 
-export(get_lang)
+export(get_swearwords)
diff --git a/R/filtering.R b/R/filtering.R
@@ -11,9 +11,9 @@
 #' @export
 #'
 #' @examples
-#' en_swear_words <- get_lang("en")
+#' en_swear_words <- get_swearwords("en")
 #' head(en_swear_words)
-get_lang <- function(lang_code) {
+get_swearwords <- function(lang_code) {
 	lang_index <- sweary::swear_words$language == lang_code
 
 	if (sum(lang_index) == 0) {

diff --git a/README.Rmd b/README.Rmd
@@ -68,7 +68,7 @@ head(swear_words)
 You can only extract one language that you are interested in.
 
 ```{r ex_one_lang}
-en_swear_words <- get_lang("en")
+en_swear_words <- get_swearwords("en")
 head(en_swear_words)
 ```
 

diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ head(swear_words)
 You can only extract one language that you are interested in.
 
 ``` r
-en_swear_words <- get_lang("en")
+en_swear_words <- get_swearwords("en")
 head(en_swear_words)
 ```
 

diff --git a/man/get_lang.Rd → man/get_swearwords.Rd b/man/get_lang.Rd → man/get_swearwords.Rd
diff --git a/tests/testthat/test_filtering.R b/tests/testthat/test_filtering.R
@@ -2,12 +2,12 @@ context("Filtering tools")
 
 test_that("filtering a language works", {
 	lang_code <- "en"
-	lang <- get_lang(lang_code)
+	lang <- get_swearwords(lang_code)
 
 	expect_gt(nrow(lang), 0)
 	expect_equal(lang_code, unique(lang$language))
 })
 
 test_that("filtering a non-existent language doesn't work", {
-	expect_error(get_lang("non-existent"))
+	expect_error(get_swearwords("non-existent"))
 })