Skip to content

Commit ba4f11c

Browse files
committed
Rename vignette
Add grok reference Add URLs into README
1 parent 8d7df74 commit ba4f11c

File tree

5 files changed

+36
-15
lines changed

5 files changed

+36
-15
lines changed

README.Rmd

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,12 @@ search_bitbucket("assertions", rlang = FALSE) # or search_bb(...)
127127
## AI Assistants
128128

129129
The package also provides functions to query AI assistants directly from R.
130+
The following AI Assistant platforms are supported: OpenAI's [ChatGPT](https://chatgpt.com/),
131+
Anthropic's [Claude](https://claude.ai/),
132+
[Perplexity](https://www.perplexity.ai/),
133+
Microsoft (Bing)'s [Copilot](https://copilot.microsoft.com/),
134+
Mistral's [le Chat](https://chat.mistral.ai/chat),
135+
xAI's [Grok](https://grok.com/), and [Meta.ai](https://www.meta.ai/).
130136
These functions open a browser with your query pre-filled, using customizable
131137
prompts that help the AI give more effective responses for R programming:
132138

@@ -137,6 +143,7 @@ ask_claude("Explain what purrr::map_df does")
137143
ask_perplexity("Compare dplyr vs data.table performance")
138144
ask_mistral("How to handle missing data in R?")
139145
ask_bing_copilot("Write a function to calculate the median")
146+
ask_grok("What is better base R or tidyverse for research?")
140147
ask_meta_ai("What are the best R packages for time series analysis?")
141148

142149
# Search with an error message
@@ -157,7 +164,7 @@ ask_chatgpt(
157164
)
158165
```
159166

160-
See `vignette("search-with-ai-assistants", package = "searcher")` for more
167+
See `vignette("using-ai-assistants-with-searcher", package = "searcher")` for more
161168
details on using AI assistants in searches through `searcher`.
162169

163170
## AI Prompt Management

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,12 @@ The goal of `searcher` is to provide a search interface directly inside
1717
of *R*. For example, to look up `rcpp example numeric vector` or
1818
`ggplot2 fix axis labels` call one of the `search_*()` functions to
1919
automatically have a web browser open, go to a search site, and type the
20-
query. `searcher` also provides direct integration with AI assistants,
21-
allowing you to send queries to ChatGPT, Claude, and other AI services
22-
with R-optimized prompts. By default, the search functions will attempt
23-
to search the last error on call if no query is specified.
20+
query. `searcher` also provides direct integration with AI assistants
21+
through `ask_*()` functions, allowing you to send queries to ChatGPT,
22+
Claude, and other AI services with R-optimized prompts.
23+
24+
By default, the search and ask functions will attempt to search the last
25+
error on call if no query is specified.
2426

2527
<figure>
2628
<img src="https://i.imgur.com/Zq2rg6G.gif"
@@ -125,9 +127,15 @@ search_bitbucket("assertions", rlang = FALSE) # or search_bb(...)
125127
## AI Assistants
126128

127129
The package also provides functions to query AI assistants directly from
128-
R. These functions open a browser with your query pre-filled, using
129-
customizable prompts that help the AI give more effective responses for
130-
R programming:
130+
R. The following AI Assistant platforms are supported: OpenAI’s
131+
[ChatGPT](https://chatgpt.com/), Anthropic’s
132+
[Claude](https://claude.ai/), [Perplexity](https://www.perplexity.ai/),
133+
Microsoft (Bing)’s [Copilot](https://copilot.microsoft.com/), Mistral’s
134+
[le Chat](https://chat.mistral.ai/chat), xAI’s
135+
[Grok](https://grok.com/), and [Meta.ai](https://www.meta.ai/). These
136+
functions open a browser with your query pre-filled, using customizable
137+
prompts that help the AI give more effective responses for R
138+
programming:
131139

132140
``` r
133141
# Get coding help from AI assistants
@@ -136,6 +144,7 @@ ask_claude("Explain what purrr::map_df does")
136144
ask_perplexity("Compare dplyr vs data.table performance")
137145
ask_mistral("How to handle missing data in R?")
138146
ask_bing_copilot("Write a function to calculate the median")
147+
ask_grok("What is better base R or tidyverse for research?")
139148
ask_meta_ai("What are the best R packages for time series analysis?")
140149

141150
# Search with an error message

vignettes/faq.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The package supports multiple types of platforms:
6060
- **Search Engines**
6161
- Google, Bing, DuckDuckGo, Startpage, Ecosia, Qwant, Brave, Kagi, Rseek
6262
- **AI Assistants**
63-
- ChatGPT, Claude, Perplexity, Mistral, Bing Copilot, Meta AI
63+
- ChatGPT, Claude, Perplexity, Mistral, Microsoft (Bing)'s Copilot, Grok, Meta AI
6464
- **Developer Communities**
6565
- StackOverflow, Posit Community, Twitter/X, Mastodon, BlueSky
6666
- **Code Repositories**
@@ -215,7 +215,7 @@ ai_prompt("As an R educator, explain this concept in detail:")
215215
ask_chatgpt("What is the tidyverse?")
216216
```
217217

218-
See `vignette("search-with-ai-assistants", "searcher")` for more details on
218+
See `vignette("using-ai-assistants-with-searcher", "searcher")` for more details on
219219
effective prompting.
220220

221221
## Prompt Management

vignettes/managing-ai-prompts.Rmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "Managing AI Prompts in `searcher`"
2+
title: "Managing AI Prompts in searcher"
33
author: "James Joseph Balamuta"
44
date: "`r Sys.Date()`"
55
output: rmarkdown::html_vignette
66
vignette: >
7-
%\VignetteIndexEntry{Managing AI Prompts in `searcher`}
7+
%\VignetteIndexEntry{Managing AI Prompts in searcher}
88
%\VignetteEngine{knitr::rmarkdown}
99
%\VignetteEncoding{UTF-8}
1010
---
@@ -23,7 +23,7 @@ knitr::opts_chunk$set(
2323
The `searcher` package includes a powerful prompt management system for working
2424
with AI assistants. This vignette explains how to use this system to create,
2525
manage, and apply effective prompts when using AI search functions. It
26-
complements the main `vignette("search-with-ai-assistants", package = "searcher")`,
26+
complements the main `vignette("using-ai-assistants-with-searcher", package = "searcher")`,
2727
which provides a broader overview of using AI services with R.
2828

2929
## What are Prompts?
@@ -236,7 +236,7 @@ approach enhances the quality of AI-generated responses and, subsequently,
236236
helps you save time and improve the efficiency of your R workflow.
237237

238238
The system presented in this vignette transforms the custom prompts described
239-
in `vignette("search-with-ai-assistants", package = "searcher")` from one-off tools
239+
in `vignette("using-ai-assistants-with-searcher", package = "searcher")` from one-off tools
240240
into a systematic library that can be maintained, shared, and reused. This
241241
represents a shift from ad-hoc prompting to a more deliberate approach that
242242
treats prompts as valuable assets in your R programming toolkit.

vignettes/search-with-ai-assistants.Rmd renamed to vignettes/using-ai-assistants-with-searcher.Rmd

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ The package supports the following AI services:
3333
3. **Perplexity** (`ask_perplexity()`) - Research-focused AI with internet search capabilities
3434
4. **Mistral** (`ask_mistral()`) - Mistral AI's assistant with strong reasoning capabilities
3535
5. **Bing Copilot** (`ask_bing_copilot()` or `ask_copilot()`) - Microsoft's AI assistant with web search integration
36-
6. **Meta AI** (`ask_meta_ai()`) - Meta's conversational AI assistant
36+
6. **Grok** (`ask_grok()`) - xAI's AI assistant, known for its desire to maximize truth and objectivity
37+
7. **Meta AI** (`ask_meta_ai()`) - Meta's conversational AI assistant
3738

3839
# Basic Usage
3940

@@ -57,6 +58,9 @@ ask_mistral("Debug this function: calculate_median <- function(x) mean(x)")
5758
# Compare programming approaches with Bing Copilot
5859
ask_copilot("Compare data.table vs dplyr for large datasets")
5960

61+
# Ask Grok about R best practices
62+
ask_grok("What are the best practices for data cleaning in R?")
63+
6064
# Ask Meta AI about best practices
6165
ask_meta_ai("What's the best way to handle missing data in R?")
6266
```
@@ -78,6 +82,7 @@ The following URLs are used to create new chat sessions:
7882
| `ask_perplexity()` | Perplexity AI | `https://www.perplexity.ai/search?q=` (with additional parameters) |
7983
| `ask_mistral()` | Mistral AI | `https://chat.mistral.ai/chat?q=` |
8084
| `ask_bing_copilot()` | Microsoft Bing Copilot | `https://www.bing.com/search?showconv=1&sendquery=1&q=` |
85+
| `ask_grok()` | xAI | `https://www.grok.com/?q=` |
8186
| `ask_meta_ai()` | Meta AI | `https://www.meta.ai/?q=` |
8287

8388
## Account Requirements

0 commit comments

Comments
 (0)