diff --git a/DESCRIPTION b/DESCRIPTION index c8945cf..56e4c72 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: forgot Type: Package Title: Function Reference Search In Console -Version: 0.1.0 +Version: 0.1.1 Author: Sam Parmar Maintainer: Sam Parmar Description: Search for that one function you need in that one package. diff --git a/NEWS.md b/NEWS.md index bd0c274..187d531 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,9 @@ +# forgot 0.1.1 + +* Fixed bug in `forgot_exmpls()` where the function was not running `filter_fx()` correctly +* Similar bug fix for `forgot_usg()` +* Updated readme with shortcut functions + # forgot 0.1.0 * Added a `NEWS.md` file to track changes to the package. diff --git a/README.Rmd b/README.Rmd index e13d171..f18f17e 100644 --- a/README.Rmd +++ b/README.Rmd @@ -76,11 +76,35 @@ forgot("stringr", keyword = "count", selected = c("title", "desc"), Here's how you can cat (?`cat()` for more info) the parameter field, usage field, or example field. Try it out to see how it looks. ```{r eval = F} forgot_params("dplyr", "count") -forgot_usage("dplyr", "count") +forgot_usg("dplyr", "count") forgot_exmpls("dplyr", "count") ``` The write logical (see `forgot_exmpls()` documentation for example) argument will create a new RStudio document with the roxygen2 field content of interest that was cat. +### Shortcuts + +You can also use some shortcut operators to get the same results as above. +```{r eval = F} +# shortcut for forgot2 +"dplyr" %f2% "count" +## OR +dplyr %f2% "count" +# shortcut for forgot_usg +"dplyr" %fu% "count" +## OR +dplyr %fu% count +# shortcut for forgot_exmpls +"dplyr" %fe% "count" +## OR +dplyr %fe% count + +# shortcut for forgot_params +"dplyr" %fp% "count" +## OR +dplyr %fp% count +``` + + ## Credits - Hex icon created using the [hexmake diff --git a/README.md b/README.md index a77d6f1..b12a694 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ usage field, or example field. Try it out to see how it looks. ``` r forgot_params("dplyr", "count") -forgot_usage("dplyr", "count") +forgot_usg("dplyr", "count") forgot_exmpls("dplyr", "count") ``` @@ -115,6 +115,31 @@ The write logical (see `forgot_exmpls()` documentation for example) argument will create a new RStudio document with the roxygen2 field content of interest that was cat. +### Shortcuts + +You can also use some shortcut operators to get the same results as +above. + +``` r +# shortcut for forgot2 +"dplyr" %f2% "count" +## OR +dplyr %f2% "count" +# shortcut for forgot_usg +"dplyr" %fu% "count" +## OR +dplyr %fu% count +# shortcut for forgot_exmpls +"dplyr" %fe% "count" +## OR +dplyr %fe% count + +# shortcut for forgot_params +"dplyr" %fp% "count" +## OR +dplyr %fp% count +``` + ## Credits - Hex icon created using the [hexmake