Merge pull request #24 from nhs-r-community/add-parameters

Added detail about fix_invalid
nhs-r-community · Jan 26, 2024 · 8298f6e · 8298f6e
2 parents 3c56632 + 8490756
commit 8298f6e
Showing 1 changed file with 14 additions and 0 deletions.
diff --git 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)
+
+```