Skip to content
This repository has been archived by the owner on Oct 12, 2023. It is now read-only.

Commit

Permalink
Minor documentation fixes (#331)
Browse files Browse the repository at this point in the history
* fix setHttpTraffic documentation

* corrected job error troubleshooting link

* updated getJobFile man page to reflect actual taskID naming

* fixed broken link to managing storage
  • Loading branch information
angusrtaylor authored and brnleehng committed Nov 26, 2018
1 parent 975d68e commit 6d14d45
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions R/file-operations.R
Expand Up @@ -59,8 +59,8 @@ getClusterFile <-
#'
#' @examples
#' \dontrun{
#' stdoutFile <- getJobFile("job20170822055031", "job20170822055031-task1", "stderr.txt")
#' getJobFile("job20170822055031", "job20170822055031-task1", "stdout.txt", downloadPath = "hello.txt")
#' stdoutFile <- getJobFile("job20170822055031", "1", "stderr.txt")
#' getJobFile("job20170822055031", "1", "stdout.txt", downloadPath = "hello.txt")
#' }
#' @export
getJobFile <-
Expand Down
2 changes: 1 addition & 1 deletion R/utility-string.R
Expand Up @@ -8,7 +8,7 @@ getTaskFailedErrorString <- function(...) {
"For more information about getting job logs, follow this link:",
paste0(
"https://github.com/Azure/doAzureParallel/blob/master/docs/",
"40-troubleshooting.md#viewing-files-directly-from-compute-node"
"90-troubleshooting.md#viewing-files-directly-from-compute-node"
)
)

Expand Down
8 changes: 4 additions & 4 deletions docs/90-troubleshooting.md
Expand Up @@ -26,17 +26,17 @@ setVerbose(FALSE)
```
### Setting HttpTraffic to Debug

To debug your doAzureParallel jobs, you can set the package to operate on *verbose* mode:
To debug your doAzureParallel jobs, you can set the verbosity for calling httr rest api calls:

```R
# turn on verbose mode
setVerbose(TRUE)
setHttpTraffic(TRUE)

# turn off verbose mode
setVerbose(FALSE)
setHttpTraffic(FALSE)
```
### Viewing files from Azure Storage
In every foreach run, the job will push its logs into Azure Storage that can be fetched by the user. For more information on reading log files, check out [managing storage](./41-managing-storage-via-R.md).
In every foreach run, the job will push its logs into Azure Storage that can be fetched by the user. For more information on reading log files, check out [managing storage](./73-managing-storage.md).

By default, when wait is set to TRUE, job and its result is automatically deleted after the run is completed. To keep the job and its result for investigation purpose, you can set a global environment setting or specify an option in foreach loop to keep it.

Expand Down

0 comments on commit 6d14d45

Please sign in to comment.