Skip to content

Commit

Permalink
docs: add example request in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joelbeckmann committed Jan 10, 2025
1 parent f19faa2 commit f78524a
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,16 @@ In that case either delete your browser cache or open the OpenCPU API Explorer i
Open [http://localhost/ocpu/](http://localhost:80/ocpu/) in your browser to access the OpenCPU API Explorer interface.

In the interface you can run any functions and access included data of the fearbase package by making requests in `../library/fearbase/`.
Check the [OpenCPU API docs](https://www.opencpu.org/api.html#api-methods) for information on how to use the OpenCPU API Explorer
Check the [OpenCPU API docs](https://www.opencpu.org/api.html#api-methods) for information on how to use the OpenCPU API Explorer

#### Example Request

To run `jsonSummary` on the `randomData` enter:
* Method: `POST`
* Endpoint: `../library/fearbase/R/jsonSummary`
* Param Name: `d`
* Param Value: `randomData`

To see the result of the analysis, pick one of the links in the response and run a get request on it:
* Method: `GET`
* Endpoint: `/ocpu/tmp/<hash>/stdout`

0 comments on commit f78524a

Please sign in to comment.