update vignettes with new flow for rcromwell getting proof token #2

getwilds · Jan 31, 2024 · 573c5eb · 573c5eb
1 parent 49c6c29
commit 573c5eb
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 17 deletions.
diff --git a/vignettes/proofr.Rmd b/vignettes/proofr.Rmd
@@ -71,24 +71,19 @@ Set the Cromwell server URL to be recognized by `rcromwell`
 cromwell_config(cromwell_url)
 ```
 
-Set the `Authorization` HTTP header to be used in all `rcromwell` HTTP requests
-
-
-```r
-httr::set_config(proof_header())
-```
-
-You should now be able to interact with your Cromwell server with authentication details retrieved via the `proofr` package!
+In addition to setting the Cromwell URL, your PROOF API token is also required for HTTP requests to your server. As long as you've loaded `rcromwell` (via `library(rcromwell)`) and run `proof_authenticate()` successfully, then you should be able to interact with your Cromwell server!
 
 ## Interact with the Cromwell server
 
-Now, check the version of your Cromwell server
+As an example, `cromwell_version()` checks the version of your Cromwell server
 
 
 ```r
 cromwell_version()
 ```
 
+See the many functions in [rcromwell documentation](https://getwilds.org/rcromwell/reference/).
+
 ## Done!
 
 You're now setup to interact with your Cromwell server. See the `rcromwell` [package docs](https://getwilds.org/rcromwell/) to get started.
diff --git a/vignettes/proofr.Rmd.og b/vignettes/proofr.Rmd.og
@@ -71,22 +71,18 @@ Set the Cromwell server URL to be recognized by `rcromwell`
 cromwell_config(cromwell_url)
 ```
 
-Set the `Authorization` HTTP header to be used in all `rcromwell` HTTP requests
-
-```{r set-auth-header}
-httr::set_config(proof_header())
-```
-
-You should now be able to interact with your Cromwell server with authentication details retrieved via the `proofr` package!
+In addition to setting the Cromwell URL, your PROOF API token is also required for HTTP requests to your server. As long as you've loaded `rcromwell` (via `library(rcromwell)`) and run `proof_authenticate()` successfully, then you should be able to interact with your Cromwell server!
 
 ## Interact with the Cromwell server
 
-Now, check the version of your Cromwell server
+As an example, `cromwell_version()` checks the version of your Cromwell server
 
 ```{r cromwell-version}
 cromwell_version()
 ```
 
+See the many functions in [rcromwell documentation](https://getwilds.org/rcromwell/reference/).
+
 ## Done!
 
 You're now setup to interact with your Cromwell server. See the `rcromwell` [package docs](https://getwilds.org/rcromwell/) to get started.