Update workspace_report documentation and functionality

[charlie-gallagher]

I really like this function, but I had to look at the source to figure out that the req_body argument is supposed to be a file path.

Other features to add:

• Debug
• Return raw result

[charlie-gallagher]

Actually, it looks like the only problem with giving a raw string is the first assertthat clause

[charlie-gallagher]

@benrwoodard What's the story behind this function? There's a lot of prep before you pass the json string to the API, how come?

[benrwoodard]

This was the original function used to pull data. I lack a clear understanding of a valuable use case that would use this function vs the aw_freeform_table function. The documentation could definitely be clearer but before spending the time on updating the function can you describe a valuable use case?

[charlie-gallagher]

I think the function would be better if it were simplified actually—so it let you get a raw response from the API yourself.

The value would be that you could use the workspace debugger to find a complex query like that for a flow visualization.

Now, sure you can just click “download as csv” in workspace, but maybe I want to build this flow visualization weekly and include it in some other existing R report. I can save a copy of the request jsons, update their dates each week, and then pull and process the data myself.

It’s no doubt a small use case, but it’s also pretty trivial to write the function. I can open a PR with a working version I have

[benrwoodard]

That is a great use case.