Skip to content
This repository was archived by the owner on May 14, 2018. It is now read-only.

Commit 98f9740

Browse files
committed
fixed README
1 parent 2cf72f4 commit 98f9740

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ The `testdat` package has two types of functions -- those to test for errors in
2121
The testing suite of functions should be used immediately after loading a data.frame into R. These functions are prepended with `test`. This suite has two goals -- first, it allows you as a user to immediately identify potential issues with the data. Second, it functions to communiate to readers of your analysis that you investigated errors in your data. One possible usecase, then, is to print the results of these tests in your analysis or documentation immediately after loading the data.
2222

2323
```coffee
24-
> data <- read.csv("local/2012.csv")
24+
> data <- read.csv("tests/testthat/data/2012.csv")
2525
> test_utf8(data)
2626
[1] FALSE
2727
```
2828

2929
The correcting suite of functions should be used in the case that the testing suite of functions elucidate issues with your data. These functions are prepended with `fix`. Not every testing function has a correction function -- for example, a correction function for `test_outliers.R` would have serious statistical implications. However, for functions such as `test_utf8.R`, we have included a `fix_utf8.R` function for a quick fix to a negative test.
3030

3131
```coffee
32-
> data <- read.csv("local/km1314-waypoints.csv", header=FALSE)
32+
> data <- read.csv("tests/testthat/data/km1314-waypoints.csv", header=FALSE)
3333
> test_utf8(data)
3434
[1] TRUE
3535
> clean_data <- fix_utf8(data)

0 commit comments

Comments
 (0)