Skip to content

Commit

Permalink
forefront Getting Started vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
simonpcouch committed Oct 11, 2024
1 parent f919df5 commit f1f2d65
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 12 deletions.
4 changes: 1 addition & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ You can install pal like so:
pak::pak("simonpcouch/pal")
```

Then, ensure that you have an [`ANTHROPIC_API_KEY`](https://console.anthropic.com/) set in your `.Renviron`---see [usethis::edit_r_environ()](https://usethis.r-lib.org/reference/edit.html) for more information. If you'd like to use an LLM other than Anthropic's Claude 3.5 Sonnet—like OpenAI's ChatGPT—to power the pal, see [`?.pal_init()`](https://simonpcouch.github.io/pal/reference/pal.html) for information on how to set default metadata on that model.

<!-- TODO: link to getting started instead of `.?pal_init()` -->
Then, ensure that you have an [`ANTHROPIC_API_KEY`](https://console.anthropic.com/) environment variable set, and you're ready to go. If you'd like to use an LLM other than Anthropic's Claude 3.5 Sonnet—like OpenAI's ChatGPT—to power the pal, see the [Getting started with pal](https://simonpcouch.github.io/pal/articles/pal.html) vignette.

## Example

Expand Down
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,11 @@ pak::pak("simonpcouch/pal")
```

Then, ensure that you have an
[`ANTHROPIC_API_KEY`](https://console.anthropic.com/) set in your
`.Renviron`—see
[usethis::edit_r_environ()](https://usethis.r-lib.org/reference/edit.html)
for more information. If you’d like to use an LLM other than Anthropic’s
Claude 3.5 Sonnet—like OpenAI’s ChatGPT—to power the pal, see
[`? .pal_init()`](https://simonpcouch.github.io/pal/reference/pal.html) for
information on how to set default metadata on that model.
[`ANTHROPIC_API_KEY`](https://console.anthropic.com/) environment
variable set, and you’re ready to go. If you’d like to use an LLM other
than Anthropic’s Claude 3.5 Sonnet—like OpenAI’s ChatGPT—to power the
pal, see the [Getting started with
pal](https://simonpcouch.github.io/pal/articles/pal.html) vignette.

## Example

Expand Down
6 changes: 4 additions & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ template:
reference:
- title: "Using pal"
desc: >
Users of pal will generally not need to call any functions from the
package directly. See the "Getting Started" vignette.
**Users of pal will generally not need to call any functions from the
package directly.** See the
["Getting Started with pal"](https://simonpcouch.github.io/pal/articles/pal.html)
vignette to learn how to work with—and extend—pals.
# TODO: add these vignettes
- title: Pals for package development
contents:
Expand Down

0 comments on commit f1f2d65

Please sign in to comment.