Skip to content

Commit

Permalink
Porting changes to proofr.Rmd.og and remade proofr.Rmd
Browse files Browse the repository at this point in the history
  • Loading branch information
tefirman authored and sckott committed Aug 5, 2024
1 parent e35f94b commit fda4cbb
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 13 deletions.
6 changes: 1 addition & 5 deletions vignettes/proofr.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ my_proof_token

Alternatively, save your API token directly as an environment variable named `PROOF_TOKEN` so that it can be used by other `proofr` functions without exposing your token in your code. To do so, run the following:


```r
Sys.setenv("PROOF_TOKEN" = proof_authenticate("username", "password"))
```


## Start a PROOF Server

Start a PROOF server using the `proof_start()` function:
Expand All @@ -46,7 +46,6 @@ proof_start()
```
Note: `proofr` assumes you only have one server running; if you've started a server using the app, you'll need to stop that server before starting one in R via `proofr`.


Get metadata about the PROOF server you have started, including the URL of the API, using `wait=TRUE` so that it doesn't return data until the server is fully ready to use.


Expand All @@ -56,9 +55,6 @@ cromwell_url <- metadata$cromwellUrl
cromwell_url
```




## rcromwell setup

Load `rcromwell`
Expand Down
16 changes: 8 additions & 8 deletions vignettes/proofr.Rmd.og
Original file line number Diff line number Diff line change
Expand Up @@ -33,22 +33,22 @@ my_proof_token

(note: the above token is not a real token)

On your computer, save your API token as an environment variable named `PROOF_TOKEN`.

If you've saved your `PROOF_TOKEN` env var, then you can use the other `proofr` functions.

Otherwise, you can pass your PROOF token to the `proofr` functions. If you pass your token to the functions, only do so by passing the call to `Sys.getenv` like `proof_status(token = Sys.getenv("MY_TOKEN"))`.
Alternatively, save your API token directly as an environment variable named `PROOF_TOKEN` so that it can be used by other `proofr` functions without exposing your token in your code. To do so, run the following:

```{r set-env-token}
Sys.setenv("PROOF_TOKEN" = proof_authenticate("username", "password"))
```

## Start a Cromwell Server
## Start a PROOF Server

Start the server
Start a PROOF server using the `proof_start()` function:

```{r start}
proof_start()
```
Note: `proofr` assumes you only have one server running; if you've started a server using the app, you'll need to stop that server before starting one in R via `proofr`.

Get the URL, using `wait=TRUE` so that it doesn't return data until the server is fully ready to use
Get metadata about the PROOF server you have started, including the URL of the API, using `wait=TRUE` so that it doesn't return data until the server is fully ready to use.

```{r cromwell-url}
metadata <- proof_status(wait = TRUE)
Expand Down

0 comments on commit fda4cbb

Please sign in to comment.