Merge pull request #70 from ekocsis3/docs

Update bqr_get_job example
cloudyr · Apr 26, 2021 · 86993d9 · 86993d9
2 parents 3d8bc72 + cab4827
commit 86993d9
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 22 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -28,5 +28,5 @@ Suggests:
     testthat,
     data.table,
     purrr
-RoxygenNote: 7.0.2
+RoxygenNote: 7.1.1
 VignetteBuilder: knitr
diff --git a/R/downloadData.R b/R/downloadData.R
@@ -32,7 +32,7 @@
 #'                         
 #' ## poll the job to check its status
 #' ## its done when job$status$state == "DONE"
-#' bqr_get_job("your_project", job)
+#' bqr_get_job(job$jobReference$jobId, "your_project")
 #' 
 #' ##once done, the query results are in "bigResultTable"
 #' ## extract that table to GoogleCloudStorage:
@@ -46,7 +46,7 @@
 #'                                 
 #' ## poll the extract job to check its status
 #' ## its done when job$status$state == "DONE"
-#' bqr_get_job("your_project", job_extract$jobReference$jobId)
+#' bqr_get_job(job_extract$jobReference$jobId, "your_project")
 #' 
 #' You should also see the extract in the Google Cloud Storage bucket
 #' googleCloudStorageR::gcs_list_objects("your_cloud_storage_bucket_name")
@@ -234,7 +234,7 @@ bqr_download_extract <- function(extractJob,
 #'                         
 #' ## poll the job to check its status
 #' ## its done when job$status$state == "DONE"
-#' bqr_get_job("your_project", job$jobReference$jobId)
+#' bqr_get_job(job$jobReference$jobId, "your_project")
 #' 
 #' ##once done, the query results are in "bigResultTable"
 #' ## extract that table to GoogleCloudStorage:
@@ -248,7 +248,7 @@ bqr_download_extract <- function(extractJob,
 #'                                 
 #' ## poll the extract job to check its status
 #' ## its done when job$status$state == "DONE"
-#' bqr_get_job("your_project", job_extract$jobReference$jobId)
+#' bqr_get_job(job_extract$jobReference$jobId, "your_project")
 #' 
 #' ## to download via a URL and not logging in via Google Cloud Storage interface:
 #' ## Use an email that is Google account enabled

diff --git a/R/jobs.R b/R/jobs.R
@@ -100,7 +100,7 @@ bqr_wait_for_job <- function(job, wait=5){
 #'                         
 #' ## poll the job to check its status
 #' ## its done when job$status$state == "DONE"
-#' bqr_get_job("your_project", job$jobReference$jobId)
+#' bqr_get_job(job$jobReference$jobId, "your_project")
 #' 
 #' ##once done, the query results are in "bigResultTable"
 #' ## extract that table to GoogleCloudStorage:
@@ -114,7 +114,7 @@ bqr_wait_for_job <- function(job, wait=5){
 #'                                 
 #' ## poll the extract job to check its status
 #' ## its done when job$status$state == "DONE"
-#' bqr_get_job("your_project", job_extract$jobReference$jobId)
+#' bqr_get_job(job_extract$jobReference$jobId, "your_project")
 #' 
 #' ## to download via a URL and not logging in via Google Cloud Storage interface:
 #' ## Use an email that is Google account enabled
@@ -207,4 +207,4 @@ bqr_list_jobs <- function(projectId = bqr_get_global_project(),
 
   lapply(out$jobs, as.job)
 
-}
+}
diff --git a/R/query.R b/R/query.R
@@ -167,7 +167,7 @@ bqr_query <- function(projectId = bqr_get_global_project(),
 #'                         
 #' ## poll the job to check its status
 #' ## its done when job$status$state == "DONE"
-#' bqr_get_job("your_project", job$jobReference$jobId)
+#' bqr_get_job(job$jobReference$jobId, "your_project")
 #' 
 #' ##once done, the query results are in "bigResultTable"
 #' ## extract that table to GoogleCloudStorage:
@@ -181,7 +181,7 @@ bqr_query <- function(projectId = bqr_get_global_project(),
 #'                                 
 #' ## poll the extract job to check its status
 #' ## its done when job$status$state == "DONE"
-#' bqr_get_job("your_project", job_extract$jobReference$jobId)
+#' bqr_get_job(job_extract$jobReference$jobId, "your_project")
 #' 
 #' ## to download via a URL and not logging in via Google Cloud Storage interface:
 #' ## Use an email that is Google account enabled
@@ -258,4 +258,4 @@ bqr_query_asynch <- function(projectId = bqr_get_global_project(),
 
   as.job(out)
 
-}
+}
diff --git a/man/bqr_extract_data.Rd b/man/bqr_extract_data.Rd
diff --git a/man/bqr_get_job.Rd b/man/bqr_get_job.Rd
diff --git a/man/bqr_grant_extract_access.Rd b/man/bqr_grant_extract_access.Rd
diff --git a/man/bqr_query.Rd b/man/bqr_query.Rd
diff --git a/man/bqr_query_asynch.Rd b/man/bqr_query_asynch.Rd
diff --git a/vignettes/bigQueryR.Rmd b/vignettes/bigQueryR.Rmd
@@ -97,7 +97,7 @@ job <- bqr_query_asynch("your_project",
 
 ## poll the job to check its status
 ## its done when job$status$state == "DONE"
-bqr_get_job("your_project", job$jobReference$jobId)
+bqr_get_job(job$jobReference$jobId, "your_project")
 
 ##once done, the query results are in "bigResultTable"
 ```
@@ -117,7 +117,7 @@ job_extract <- bqr_extract_data("your_project",
 
 ## poll the extract job to check its status
 ## its done when job$status$state == "DONE"
-bqr_get_job("your_project", job_extract$jobReference$jobId)
+bqr_get_job(job_extract$jobReference$jobId, "your_project")
 
 ## to download via a URL and not logging in via Google Cloud Storage interface:
 ## Use an email that is Google account enabled