From 8490756b80d45e1f3c7b3e5b6da850c7671d737d Mon Sep 17 00:00:00 2001 From: Lextuga007 Date: Fri, 26 Jan 2024 18:27:51 +0000 Subject: [PATCH] Added detail about fix_invalid --- vignettes/NHSRpostcodetools.Rmd | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/vignettes/NHSRpostcodetools.Rmd b/vignettes/NHSRpostcodetools.Rmd index 962059e..3715e79 100644 --- a/vignettes/NHSRpostcodetools.Rmd +++ b/vignettes/NHSRpostcodetools.Rmd @@ -60,3 +60,17 @@ postcode_data_join(test_df1, fix_invalid = TRUE) ``` +Note that the parameter `fix_invalid = TRUE` defaults to TRUE: + +```{r} +postcode_data_join(test_df1) + +``` + +And if it is set to FALSE the same message appears but the `new_postcode` is not +populated and has `NA`. + +```{r} +postcode_data_join(test_df1, fix_invalid = FALSE) + +```