diff --git a/authors.html b/authors.html index dece441..f74d4da 100644 --- a/authors.html +++ b/authors.html @@ -45,13 +45,15 @@

Citation

Guenther F (2024). ecopiapi: R package to interact with the ecopi API. -R package version 0.1.3, https://oekofor.github.io/ecopiapi/, https://github.com/OekoFor/ecopiapi. +R package version 0.1.3, +https://oekofor.github.io/ecopiapi/, https://github.com/OekoFor/ecopiapi. 

@Manual{,
   title = {ecopiapi: R package to interact with the ecopi API},
   author = {Felix Guenther},
   year = {2024},
-  note = {R package version 0.1.3, https://oekofor.github.io/ecopiapi/},
+  note = {R package version 0.1.3,
+    https://oekofor.github.io/ecopiapi/},
   url = {https://github.com/OekoFor/ecopiapi},
 }
diff --git a/pkgdown.yml b/pkgdown.yml index c3d0c6f..35c6665 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.11 pkgdown: 2.1.0 pkgdown_sha: ~ articles: {} -last_built: 2024-07-10T07:44Z +last_built: 2024-07-10T08:34Z urls: reference: https://oekofor.github.io/ecopiapi/reference article: https://oekofor.github.io/ecopiapi/articles diff --git a/reference/ecopiapi-package.html b/reference/ecopiapi-package.html index 3d660ff..d258f23 100644 --- a/reference/ecopiapi-package.html +++ b/reference/ecopiapi-package.html @@ -40,6 +40,7 @@

ecopiapi: R package to interact with the ecopi API

See also

Useful links:

diff --git a/reference/get_detections.html b/reference/get_detections.html index f3c2883..2899ab7 100644 --- a/reference/get_detections.html +++ b/reference/get_detections.html @@ -57,8 +57,9 @@

Value

Examples

# Retrieve a list of detections for project '017_neeri' that occurred in March (month=3)
-get_detections(project_name = "017_neeri", datetime__month = 3)
-#> Error in get_ecopiapi_key(): No key found
+ if (FALSE) { # \dontrun{
+ get_detections(project_name = "017_neeri", datetime__month = 3)
+ } # }
diff --git a/reference/get_historicalprojects.html b/reference/get_historicalprojects.html index cabb873..02e2c6a 100644 --- a/reference/get_historicalprojects.html +++ b/reference/get_historicalprojects.html @@ -57,12 +57,10 @@

Value

Examples

# retrieve a dataframe of all historical projects
-get_historicalprojects()
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_historicalprojects() # \dontrun{}
 
 # Retrieve a list of projects that contain 'red_panda' or 'green_banana' in their name
-get_historicalprojects(project_name__in = "red_panda, green_banana")
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_historicalprojects(project_name__in = "red_panda, green_banana") # \dontrun{}
diff --git a/reference/get_historicalrecordergroups.html b/reference/get_historicalrecordergroups.html index 503be9d..5d91f14 100644 --- a/reference/get_historicalrecordergroups.html +++ b/reference/get_historicalrecordergroups.html @@ -60,8 +60,7 @@

Value

Examples

# Retrieve a data frame of historical recorder groups for project 'oekofor'
-get_historicalrecordergroups(project_name = "oekofor")
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_historicalrecordergroups(project_name = "oekofor") # \dontrun{}
diff --git a/reference/get_historicalrecorders.html b/reference/get_historicalrecorders.html index 7fbb64f..783354d 100644 --- a/reference/get_historicalrecorders.html +++ b/reference/get_historicalrecorders.html @@ -57,8 +57,7 @@

Value

Examples

# Retrieve a list of historical recorders for project '017_neeri'
-get_historicalrecorders(project_name = "017_neerach_ried")
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_historicalrecorders(project_name = "017_neerach_ried") # \dontrun{}
diff --git a/reference/get_mediafile.html b/reference/get_mediafile.html index a812bb3..c010631 100644 --- a/reference/get_mediafile.html +++ b/reference/get_mediafile.html @@ -56,8 +56,7 @@

Value

Examples

- 
get_mediafile("c8c155f9-c05b-4e86-b842-88b80829e36c")
-#> Error in get_ecopiapi_key(): No key found
+    
if (FALSE) get_mediafile("c8c155f9-c05b-4e86-b842-88b80829e36c") # \dontrun{}
diff --git a/reference/get_project_info.html b/reference/get_project_info.html index 446e636..9189e31 100644 --- a/reference/get_project_info.html +++ b/reference/get_project_info.html @@ -45,8 +45,8 @@

Usage

Arguments

-
...
-

query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_projects_list.

+
project_name
+

Name of the project.

@@ -61,8 +61,7 @@

Details

Examples

# Retrieve information about the '017_neeri' project
-get_project_info(project_name = "017_neeri")
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_project_info(project_name = "017_neeri") # \dontrun{}

diff --git a/reference/get_projects.html b/reference/get_projects.html index 79ad731..e2401c1 100644 --- a/reference/get_projects.html +++ b/reference/get_projects.html @@ -57,12 +57,10 @@

Value

Examples

# retrieve a dataframe of all projects
-get_projects()
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_projects() # \dontrun{}
 
 # Retrieve a list of projects that contain 'red_panda' or 'green_banana' in their name
-get_projects(project_name__in = "red_panda, green_banana")
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_projects(project_name__in = "red_panda, green_banana") # \dontrun{}
diff --git a/reference/get_recordergroups.html b/reference/get_recordergroups.html index e958ee1..58891cb 100644 --- a/reference/get_recordergroups.html +++ b/reference/get_recordergroups.html @@ -60,8 +60,7 @@

Value

Examples

# Retrieve a data frame of recorder groups for project 'oekofor'
-get_recordergroups(project_name = "oekofor")
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_recordergroups(project_name = "oekofor") # \dontrun{}
diff --git a/reference/get_recorderlogs.html b/reference/get_recorderlogs.html new file mode 100644 index 0000000..2462208 --- /dev/null +++ b/reference/get_recorderlogs.html @@ -0,0 +1,83 @@ + +Get recorder logs list. — get_recorderlogs • ecopiapi + Skip to contents + + +
+
+
+ +

Get recorder logs list.

+ Source: R/api.R +
get_recorderlogs.Rd
+
+ +
+

Wrapper around the 'recorderlogs_list' endpoint to retrieve a list of recorder logs based on the specified query parameters.

+
+ +
+

Usage

+ 
get_recorderlogs(...)
+
+ +
+

Arguments

+ + +
...
+

query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderlogs_list.

+ +
+
+

Value

+

A dataframe containing the recorder logs that match the specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderlogs_list.

+
+ +
+

Examples

+ 
# Retrieve a dataframe of recorder logs for project '017_neeri'
+if (FALSE) get_recorderlogs(project_name = "017_neeri") # \dontrun{}
+
+
+
+
+ + +
+

Developed by Felix Guenther.

+
+ +
+

Site built with pkgdown 2.1.0.

+
+ +
+ + + + + + + diff --git a/reference/get_recorders.html b/reference/get_recorders.html index 76d7185..f7cd9cc 100644 --- a/reference/get_recorders.html +++ b/reference/get_recorders.html @@ -1,5 +1,5 @@ -Get recorder log info. — get_recorders • ecopiapi +Get recorders list. — get_recorders • ecopiapi Skip to contents @@ -27,13 +27,13 @@
-

Get recorder log info.

+

Get recorders list.

Source: R/api.R
get_recorders.Rd
-

Wrapper around the 'recorderlogs_read' endpoint to retrieve information about a specific recorder log.

+

Wrapper around the 'recorders_list' endpoint to retrieve a list of recorders based on the specified query parameters.

@@ -48,34 +48,16 @@

Arguments...

query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorders_list.

- -
recorder_name
-

The name of the recorder to retrieve information about.

-

Value

-

A list containing information about the specified recorder log: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderlogs_retrieve.

-

TODO export function -Get recorders list.

-

Wrapper around the 'recorders_list' endpoint to retrieve a list of recorders based on the specified query parameters.

-

A dataframe containing the recorders that match the specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorders_list.

-
-
-

Details

-

This function retrieves information about a specific recorder log, based on the recorder name provided in the 'recorder_name' parameter. -The available information about a recorder log is documented in the EcoPi API documentation: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderlogs_retrieve.

+

A dataframe containing the recorders that match the specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorders_list.

Examples

- 
# Retrieve information about the recorder log for recorder '00000000d76d0bf9'
-get_recorderlog_info(recorder_name = "00000000d76d0bf9")
-#> Error in get_recorderlog_info(recorder_name = "00000000d76d0bf9"): could not find function "get_recorderlog_info"
-
-# Retrieve a list of recorders for project '017_neeri'
-get_recorders(project_name = "017_neerach_ried")
-#> Error in get_ecopiapi_key(): No key found
+    
# Retrieve a list of recorders for project '017_neeri'
+if (FALSE) get_recorders(project_name = "017_neerach_ried") # \dontrun{}
diff --git a/reference/get_recorderspeciescounts.html b/reference/get_recorderspeciescounts.html index 309c715..1596e6a 100644 --- a/reference/get_recorderspeciescounts.html +++ b/reference/get_recorderspeciescounts.html @@ -1,5 +1,5 @@ -Get summary files of detections. — get_recorderspeciescounts • ecopiapi +Get a count of detections per clas and recorder for a specific project. — get_recorderspeciescounts • ecopiapi Skip to contents @@ -27,7 +27,7 @@
-

Get summary files of detections.

+

Get a count of detections per clas and recorder for a specific project.

Source: R/api.R
get_recorderspeciescounts.Rd
@@ -45,7 +45,11 @@

Usage

Arguments

-
...
+
project_name
+

Name of the project to get a count on detetcions class and recorder

+ + +
...

query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_meta_project_detections_recorderspeciescounts_retrieve

@@ -56,7 +60,13 @@

Value

Examples

- + 
# Retrieve a count pre species and recorders. By default, the count is returned for today
+if (FALSE) get_recorderspeciescounts(project_name = "039_zitro") # \dontrun{}
+# You can specify a start_date and end_date to get a count for specific time interval.
+# Limit 'countable' detections by setting a confidence threshold
+if (FALSE) get_recorderspeciescounts(project_name = "039_zitro", start_date = "2023-01-01", end_date = "2023-12-31", min_confidence = 0.85) # \dontrun{}
+
+
diff --git a/reference/get_recorderstates.html b/reference/get_recorderstates.html index b41ccc2..9a183b7 100644 --- a/reference/get_recorderstates.html +++ b/reference/get_recorderstates.html @@ -57,12 +57,10 @@

Value

Examples

# Retrieve all recorder states
-get_recorderstates()
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_recorderstates() # \dontrun{}
 
 # Retrieve a list of recorder states for recorder '00000000d76d0bf9'
-get_recorderstates(recorder_name = "00000000d76d0bf9")
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_recorderstates(recorder_name = "00000000d76d0bf9") # \dontrun{}
diff --git a/reference/get_recordings.html b/reference/get_recordings.html index 102e339..2ca3a9c 100644 --- a/reference/get_recordings.html +++ b/reference/get_recordings.html @@ -57,8 +57,7 @@

Value

Examples

# Retrieve a list of recordings for project '017_neeri' that occurred in March (month=3)
-get_recordings(project_name = "017_neeri", datetime__month = 3)
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) get_recordings(project_name = "017_neeri", datetime__month = 3) # \dontrun{}
diff --git a/reference/index.html b/reference/index.html index b99accb..abccf65 100644 --- a/reference/index.html +++ b/reference/index.html @@ -103,16 +103,22 @@

All functionsget_recorderlogs() + + +
Get recorder logs list.
+
+ get_recorders()
-
Get recorder log info.
+
Get recorders list.
get_recorderspeciescounts()
-
Get summary files of detections.
+
Get a count of detections per clas and recorder for a specific project.
get_recorderstates() @@ -133,6 +139,12 @@

All functionspatch_recorders() + +

+
PATCH recorder.
+
+ resp_body_json_to_df()
diff --git a/reference/patch_detections.html b/reference/patch_detections.html index b3c2534..cc6371a 100644 --- a/reference/patch_detections.html +++ b/reference/patch_detections.html @@ -48,6 +48,10 @@

Arguments...

query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_detections_partial_update

+ +
id_or_uid
+

The database ID or UID of the respective detection

+

Value

@@ -57,8 +61,7 @@

Value

Examples

# Update the parameter confirmed of an example detection
-patch_detections(id_or_uid = "64733fbc-7cc8-49f6-adf1-c9ec2d676959", confirmed = "YES")
-#> Error in get_ecopiapi_key(): No key found
+if (FALSE) patch_detections(id_or_uid = "64733fbc-7cc8-49f6-adf1-c9ec2d676959", confirmed = "YES") # \dontrun{}
diff --git a/reference/patch_recorders.html b/reference/patch_recorders.html new file mode 100644 index 0000000..38b3336 --- /dev/null +++ b/reference/patch_recorders.html @@ -0,0 +1,93 @@ + +PATCH recorder. — patch_recorders • ecopiapi + Skip to contents + + +
+
+
+ +

PATCH recorder.

+ Source: R/api.R +
patch_recorders.Rd
+
+ +
+

Wrapper around the 'recorders_partial_update' endpoint to update recorders parameters based on the specified body schema.

+
+ +
+

Usage

+ 
patch_recorders(..., recorder_name, new_data, file_path)
+
+ +
+

Arguments

+ + +
...
+

query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorders_partial_update.

+ + +
recorder_name
+

The name of the recorder to update information from.

+ + +
file_path
+

Path to file to upload.

+ +
+
+

Value

+

httr2_response

+
+ +
+

Examples

+ 
# Update the parameter description of the recorder 00041aefd7jgg1014
+if (FALSE) patch_recorders(recorder_name = "008041aefd7ee1015", description = "This a recorder ...", lat = 48) # \dontrun{}
+# OR with image
+if (FALSE) patch_recorders(recorder_name = "00041aefd7jgg1014", description = "Teeeest ...", lat = 48, file_path = "/sample_path/sample.jpeg") # \dontrun{}
+
+
+
+
+ + +
+

Developed by Felix Guenther.

+
+ +
+

Site built with pkgdown 2.1.0.

+
+ +
+ + + + + + + diff --git a/search.json b/search.json index 2d56a3b..7f3af5e 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://oekofor.github.io/ecopiapi/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Felix Guenther. Author, maintainer.","code":""},{"path":"https://oekofor.github.io/ecopiapi/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Guenther F (2024). ecopiapi: R package interact ecopi API. R package version 0.1.3, https://oekofor.github.io/ecopiapi/, https://github.com/OekoFor/ecopiapi.","code":"@Manual{, title = {ecopiapi: R package to interact with the ecopi API}, author = {Felix Guenther}, year = {2024}, note = {R package version 0.1.3, https://oekofor.github.io/ecopiapi/}, url = {https://github.com/OekoFor/ecopiapi}, }"},{"path":"https://oekofor.github.io/ecopiapi/index.html","id":"ecopiapi","dir":"","previous_headings":"","what":"R package to interact with the ecopi API","title":"R package to interact with the ecopi API","text":"goal ecopiapi Get, post, patch data ecop API. Find full documentation : https://oekofor.github.io/ecopiapi/","code":""},{"path":"https://oekofor.github.io/ecopiapi/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"R package to interact with the ecopi API","text":"can install development version ecopiapi GitHub : need Github PAT authentication (privat repo). Install specific version Install latest commit main branch","code":"devtools::install_github(\"OekoFor/ecopiapi@0.1.3\", auth_token = {GITHUB_PAT}) # install.packages(\"devtools\") devtools::install_github(\"OekoFor/ecopiapi\", auth_token = {GITHUB_PAT})"},{"path":"https://oekofor.github.io/ecopiapi/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"R package to interact with the ecopi API","text":"interact API, need valid key. recommended store environmental variable .Renviron root directory th project. envar must named ECOPI_API_KEY.","code":"library(ecopiapi) get_detections_list(params = list(\"project_name\" = \"017_neeri\", \"datetime__month\" = 3)) get_latest_detections() get_latest_detections_by_project(project_name = \"017_neeri\") get_latest_detections_by_recorder(recorder_name = \"00000000d76d0bf9\") get_latest_detections_by_recordergroup(project_name = \"053_sion\", recordergroup_name = \"lapwing\") get_recordings_list(params = list(\"project_name\" = \"017_neeri\", \"datetime__month\" = 3))"},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_api.html","id":null,"dir":"Reference","previous_headings":"","what":"Make API requests to the Ecopi API — ecopi_api","title":"Make API requests to the Ecopi API — ecopi_api","text":"function sends API request Ecopi API specified resource, parameters, optional arguments.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_api.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Make API requests to the Ecopi API — ecopi_api","text":"","code":"ecopi_api(resource, ..., params = list(), new_data = list(), file_path)"},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_api.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Make API requests to the Ecopi API — ecopi_api","text":"resource character string specifying API resource request. ... Additional arguments passed req_template() function. params named list query parameters include request. new_data named list parameters updated/ patched. file_path path currently important patch image recorder endpoint.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_api.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Make API requests to the Ecopi API — ecopi_api","text":"response object httr2 package containing API response.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_api.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Make API requests to the Ecopi API — ecopi_api","text":"","code":"if (FALSE) { # \\dontrun{ # Send a request to the 'detections' endpoint. Only get detections in the project '017_neeri' response <- ecopi_api(\"GET /detections/\", params = list(\"project\" = \"017_neeri\")) # } # }"},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_error_body.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract error message from JSON body of an HTTP response — ecopi_error_body","title":"Extract error message from JSON body of an HTTP response — ecopi_error_body","text":"Extract error message JSON body HTTP response","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_error_body.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract error message from JSON body of an HTTP response — ecopi_error_body","text":"","code":"ecopi_error_body(resp)"},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_error_body.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract error message from JSON body of an HTTP response — ecopi_error_body","text":"resp HTTP response object.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_error_body.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extract error message from JSON body of an HTTP response — ecopi_error_body","text":"named character vector representing flattened JSON content HTTP response body.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_error_body.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Extract error message from JSON body of an HTTP response — ecopi_error_body","text":"","code":"if (FALSE) { # \\dontrun{ # Assuming an HTTP response object 'response' with a JSON error body error_body <- ecopi_error_body(response) } # }"},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopiapi-package.html","id":null,"dir":"Reference","previous_headings":"","what":"ecopiapi: R package to interact with the ecopi API — ecopiapi-package","title":"ecopiapi: R package to interact with the ecopi API — ecopiapi-package","text":"Get, post, patch data ecop API.","code":""},{"path":[]},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopiapi-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"ecopiapi: R package to interact with the ecopi API — ecopiapi-package","text":"Maintainer: Felix Guenther guenther@oekofor.de","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_detections.html","id":null,"dir":"Reference","previous_headings":"","what":"Get detections list. — get_detections","title":"Get detections list. — get_detections","text":"Wrapper around 'detections_list' endpoint retrieve list detections based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_detections.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get detections list. — get_detections","text":"","code":"get_detections(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_detections.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get detections list. — get_detections","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_detections_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_detections.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get detections list. — get_detections","text":"data.frame containing detections match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_detections_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_detections.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get detections list. — get_detections","text":"","code":"# Retrieve a list of detections for project '017_neeri' that occurred in March (month=3) get_detections(project_name = \"017_neeri\", datetime__month = 3) #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalprojects.html","id":null,"dir":"Reference","previous_headings":"","what":"Get historical projects list. — get_historicalprojects","title":"Get historical projects list. — get_historicalprojects","text":"Wrapper around 'historicalprojects_list' endpoint retrieve list historical projects based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalprojects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get historical projects list. — get_historicalprojects","text":"","code":"get_historicalprojects(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalprojects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get historical projects list. — get_historicalprojects","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalprojects_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalprojects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get historical projects list. — get_historicalprojects","text":"dataframe containing historical projects match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalprojects_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalprojects.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get historical projects list. — get_historicalprojects","text":"","code":"# retrieve a dataframe of all historical projects get_historicalprojects() #> Error in get_ecopiapi_key(): No key found # Retrieve a list of projects that contain 'red_panda' or 'green_banana' in their name get_historicalprojects(project_name__in = \"red_panda, green_banana\") #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecordergroups.html","id":null,"dir":"Reference","previous_headings":"","what":"Get historical recorder groups list. — get_historicalrecordergroups","title":"Get historical recorder groups list. — get_historicalrecordergroups","text":"Wrapper around 'historicalrecordergroups_list' endpoint retrieve list recorder groups based specified query parameters. contains configurations species list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecordergroups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get historical recorder groups list. — get_historicalrecordergroups","text":"","code":"get_historicalrecordergroups(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecordergroups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get historical recorder groups list. — get_historicalrecordergroups","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalrecordergroups_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecordergroups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get historical recorder groups list. — get_historicalrecordergroups","text":"list containing historical recorder groups match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalrecordergroups_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecordergroups.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get historical recorder groups list. — get_historicalrecordergroups","text":"","code":"# Retrieve a data frame of historical recorder groups for project 'oekofor' get_historicalrecordergroups(project_name = \"oekofor\") #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecorders.html","id":null,"dir":"Reference","previous_headings":"","what":"Get historical recorders list. — get_historicalrecorders","title":"Get historical recorders list. — get_historicalrecorders","text":"Wrapper around 'historicalrecorders_list' endpoint get list recorders based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecorders.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get historical recorders list. — get_historicalrecorders","text":"","code":"get_historicalrecorders(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecorders.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get historical recorders list. — get_historicalrecorders","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalrecorders_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecorders.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get historical recorders list. — get_historicalrecorders","text":"dataframe containing historical recorders match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalrecorders_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecorders.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get historical recorders list. — get_historicalrecorders","text":"","code":"# Retrieve a list of historical recorders for project '017_neeri' get_historicalrecorders(project_name = \"017_neerach_ried\") #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_mediafile.html","id":null,"dir":"Reference","previous_headings":"","what":"Get media file. — get_mediafile","title":"Get media file. — get_mediafile","text":"Wrapper around 'detections_media_retrieve' endpoint retrieve media file detection.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_mediafile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get media file. — get_mediafile","text":"","code":"get_mediafile(uid)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_mediafile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get media file. — get_mediafile","text":"uid uid specifiy detection. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_detections_media_retrieve","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_mediafile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get media file. — get_mediafile","text":"object type \"httr2_response\". contains raw data body (currently audio image)","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_mediafile.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get media file. — get_mediafile","text":"","code":"get_mediafile(\"c8c155f9-c05b-4e86-b842-88b80829e36c\") #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Get project info. — get_project_info","title":"Get project info. — get_project_info","text":"Wrapper around 'projects_retrieve' endpoint retrieve information specific project.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get project info. — get_project_info","text":"","code":"get_project_info(project_name)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get project info. — get_project_info","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_projects_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get project info. — get_project_info","text":"list containing information specified project: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_projects_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get project info. — get_project_info","text":"function retrieves information specific project, based project name provided 'project_name' parameter.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get project info. — get_project_info","text":"","code":"# Retrieve information about the '017_neeri' project get_project_info(project_name = \"017_neeri\") #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_projects.html","id":null,"dir":"Reference","previous_headings":"","what":"Get projects list. — get_projects","title":"Get projects list. — get_projects","text":"Wrapper around 'projects_list' endpoint retrieve list projects based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_projects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get projects list. — get_projects","text":"","code":"get_projects(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_projects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get projects list. — get_projects","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_projects_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_projects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get projects list. — get_projects","text":"dataframe containing projects match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_projects_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_projects.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get projects list. — get_projects","text":"","code":"# retrieve a dataframe of all projects get_projects() #> Error in get_ecopiapi_key(): No key found # Retrieve a list of projects that contain 'red_panda' or 'green_banana' in their name get_projects(project_name__in = \"red_panda, green_banana\") #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html","id":null,"dir":"Reference","previous_headings":"","what":"Get recorder groups list. — get_recordergroups","title":"Get recorder groups list. — get_recordergroups","text":"Wrapper around 'recordergroups_list' endpoint retrieve list recorder groups based specified query parameters. contains configurations species list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get recorder groups list. — get_recordergroups","text":"","code":"get_recordergroups(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get recorder groups list. — get_recordergroups","text":"... query paramaters. Leave empty get recordergroups. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recordergroups_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get recorder groups list. — get_recordergroups","text":"list containing recorder groups match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recordergroups_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get recorder groups list. — get_recordergroups","text":"","code":"# Retrieve a data frame of recorder groups for project 'oekofor' get_recordergroups(project_name = \"oekofor\") #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":null,"dir":"Reference","previous_headings":"","what":"Get recorder log info. — get_recorders","title":"Get recorder log info. — get_recorders","text":"Wrapper around 'recorderlogs_read' endpoint retrieve information specific recorder log.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get recorder log info. — get_recorders","text":"","code":"get_recorders(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get recorder log info. — get_recorders","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorders_list. recorder_name name recorder retrieve information .","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get recorder log info. — get_recorders","text":"list containing information specified recorder log: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderlogs_retrieve. TODO export function Get recorders list. Wrapper around 'recorders_list' endpoint retrieve list recorders based specified query parameters. dataframe containing recorders match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorders_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get recorder log info. — get_recorders","text":"function retrieves information specific recorder log, based recorder name provided 'recorder_name' parameter. available information recorder log documented EcoPi API documentation: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderlogs_retrieve.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get recorder log info. — get_recorders","text":"","code":"# Retrieve information about the recorder log for recorder '00000000d76d0bf9' get_recorderlog_info(recorder_name = \"00000000d76d0bf9\") #> Error in get_recorderlog_info(recorder_name = \"00000000d76d0bf9\"): could not find function \"get_recorderlog_info\" # Retrieve a list of recorders for project '017_neeri' get_recorders(project_name = \"017_neerach_ried\") #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderspeciescounts.html","id":null,"dir":"Reference","previous_headings":"","what":"Get summary files of detections. — get_recorderspeciescounts","title":"Get summary files of detections. — get_recorderspeciescounts","text":"Wrapper around 'meta_project_detections_recorderspeciescounts_retrieve' endpoint retrieve count species detections recorder given project.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderspeciescounts.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get summary files of detections. — get_recorderspeciescounts","text":"","code":"get_recorderspeciescounts(project_name, ...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderspeciescounts.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get summary files of detections. — get_recorderspeciescounts","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_meta_project_detections_recorderspeciescounts_retrieve","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderspeciescounts.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get summary files of detections. — get_recorderspeciescounts","text":"summary containing species counts per recorder within project match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_meta_project_detections_recorderspeciescounts_retrieve.","code":""},{"path":[]},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html","id":null,"dir":"Reference","previous_headings":"","what":"Get recorder states list. — get_recorderstates","title":"Get recorder states list. — get_recorderstates","text":"Wrapper around 'recorderstates_list' endpoint retrieve list recorder states based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get recorder states list. — get_recorderstates","text":"","code":"get_recorderstates(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get recorder states list. — get_recorderstates","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderstates_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get recorder states list. — get_recorderstates","text":"dataframe containing recorder states match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderstates_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get recorder states list. — get_recorderstates","text":"","code":"# Retrieve all recorder states get_recorderstates() #> Error in get_ecopiapi_key(): No key found # Retrieve a list of recorder states for recorder '00000000d76d0bf9' get_recorderstates(recorder_name = \"00000000d76d0bf9\") #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordings.html","id":null,"dir":"Reference","previous_headings":"","what":"Get recordings list. — get_recordings","title":"Get recordings list. — get_recordings","text":"Wrapper around 'recordings_list' endpoint retrieve dataframe recordings based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordings.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get recordings list. — get_recordings","text":"","code":"get_recordings(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordings.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get recordings list. — get_recordings","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recordings_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordings.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get recordings list. — get_recordings","text":"data.frame containing recordings match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recordings_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordings.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get recordings list. — get_recordings","text":"","code":"# Retrieve a list of recordings for project '017_neeri' that occurred in March (month=3) get_recordings(project_name = \"017_neeri\", datetime__month = 3) #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_detections.html","id":null,"dir":"Reference","previous_headings":"","what":"PATCH detection — patch_detections","title":"PATCH detection — patch_detections","text":"Wrapper around 'detections_partial_update' endpoint update detections parameters based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_detections.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PATCH detection — patch_detections","text":"","code":"patch_detections(..., id_or_uid)"},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_detections.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PATCH detection — patch_detections","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_detections_partial_update","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_detections.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"PATCH detection — patch_detections","text":"httr2_response","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_detections.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"PATCH detection — patch_detections","text":"","code":"# Update the parameter confirmed of an example detection patch_detections(id_or_uid = \"64733fbc-7cc8-49f6-adf1-c9ec2d676959\", confirmed = \"YES\") #> Error in get_ecopiapi_key(): No key found"},{"path":"https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert response body to data frame — resp_body_json_to_df","title":"Convert response body to data frame — resp_body_json_to_df","text":"Convert response body data frame","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert response body to data frame — resp_body_json_to_df","text":"","code":"resp_body_json_to_df(api_response)"},{"path":"https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert response body to data frame — resp_body_json_to_df","text":"api_response Response API","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert response body to data frame — resp_body_json_to_df","text":"Data frame","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert response body to data frame — resp_body_json_to_df","text":"","code":"if (FALSE) { # \\dontrun{ response <- ecopi_api(\"GET /detections/\", params = list(\"project\" = \"017_neeri\")) resp_body_json_to_df(response) } # }"}] +[{"path":"https://oekofor.github.io/ecopiapi/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Felix Guenther. Author, maintainer.","code":""},{"path":"https://oekofor.github.io/ecopiapi/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Guenther F (2024). ecopiapi: R package interact ecopi API. R package version 0.1.3, https://oekofor.github.io/ecopiapi/, https://github.com/OekoFor/ecopiapi.","code":"@Manual{, title = {ecopiapi: R package to interact with the ecopi API}, author = {Felix Guenther}, year = {2024}, note = {R package version 0.1.3, https://oekofor.github.io/ecopiapi/}, url = {https://github.com/OekoFor/ecopiapi}, }"},{"path":"https://oekofor.github.io/ecopiapi/index.html","id":"ecopiapi","dir":"","previous_headings":"","what":"R package to interact with the ecopi API","title":"R package to interact with the ecopi API","text":"goal ecopiapi Get, post, patch data ecop API. Find full documentation : https://oekofor.github.io/ecopiapi/","code":""},{"path":"https://oekofor.github.io/ecopiapi/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"R package to interact with the ecopi API","text":"can install development version ecopiapi GitHub : need Github PAT authentication (privat repo). Install specific version Install latest commit main branch","code":"devtools::install_github(\"OekoFor/ecopiapi@0.1.3\", auth_token = {GITHUB_PAT}) # install.packages(\"devtools\") devtools::install_github(\"OekoFor/ecopiapi\", auth_token = {GITHUB_PAT})"},{"path":"https://oekofor.github.io/ecopiapi/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"R package to interact with the ecopi API","text":"interact API, need valid key. recommended store environmental variable .Renviron root directory th project. envar must named ECOPI_API_KEY.","code":"library(ecopiapi) get_detections_list(params = list(\"project_name\" = \"017_neeri\", \"datetime__month\" = 3)) get_latest_detections() get_latest_detections_by_project(project_name = \"017_neeri\") get_latest_detections_by_recorder(recorder_name = \"00000000d76d0bf9\") get_latest_detections_by_recordergroup(project_name = \"053_sion\", recordergroup_name = \"lapwing\") get_recordings_list(params = list(\"project_name\" = \"017_neeri\", \"datetime__month\" = 3))"},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_api.html","id":null,"dir":"Reference","previous_headings":"","what":"Make API requests to the Ecopi API — ecopi_api","title":"Make API requests to the Ecopi API — ecopi_api","text":"function sends API request Ecopi API specified resource, parameters, optional arguments.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_api.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Make API requests to the Ecopi API — ecopi_api","text":"","code":"ecopi_api(resource, ..., params = list(), new_data = list(), file_path)"},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_api.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Make API requests to the Ecopi API — ecopi_api","text":"resource character string specifying API resource request. ... Additional arguments passed req_template() function. params named list query parameters include request. new_data named list parameters updated/ patched. file_path path currently important patch image recorder endpoint.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_api.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Make API requests to the Ecopi API — ecopi_api","text":"response object httr2 package containing API response.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_api.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Make API requests to the Ecopi API — ecopi_api","text":"","code":"if (FALSE) { # \\dontrun{ # Send a request to the 'detections' endpoint. Only get detections in the project '017_neeri' response <- ecopi_api(\"GET /detections/\", params = list(\"project\" = \"017_neeri\")) # } # }"},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_error_body.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract error message from JSON body of an HTTP response — ecopi_error_body","title":"Extract error message from JSON body of an HTTP response — ecopi_error_body","text":"Extract error message JSON body HTTP response","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_error_body.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract error message from JSON body of an HTTP response — ecopi_error_body","text":"","code":"ecopi_error_body(resp)"},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_error_body.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract error message from JSON body of an HTTP response — ecopi_error_body","text":"resp HTTP response object.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_error_body.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extract error message from JSON body of an HTTP response — ecopi_error_body","text":"named character vector representing flattened JSON content HTTP response body.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopi_error_body.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Extract error message from JSON body of an HTTP response — ecopi_error_body","text":"","code":"if (FALSE) { # \\dontrun{ # Assuming an HTTP response object 'response' with a JSON error body error_body <- ecopi_error_body(response) } # }"},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopiapi-package.html","id":null,"dir":"Reference","previous_headings":"","what":"ecopiapi: R package to interact with the ecopi API — ecopiapi-package","title":"ecopiapi: R package to interact with the ecopi API — ecopiapi-package","text":"Get, post, patch data ecop API.","code":""},{"path":[]},{"path":"https://oekofor.github.io/ecopiapi/reference/ecopiapi-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"ecopiapi: R package to interact with the ecopi API — ecopiapi-package","text":"Maintainer: Felix Guenther guenther@oekofor.de","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_detections.html","id":null,"dir":"Reference","previous_headings":"","what":"Get detections list. — get_detections","title":"Get detections list. — get_detections","text":"Wrapper around 'detections_list' endpoint retrieve list detections based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_detections.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get detections list. — get_detections","text":"","code":"get_detections(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_detections.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get detections list. — get_detections","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_detections_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_detections.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get detections list. — get_detections","text":"data.frame containing detections match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_detections_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_detections.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get detections list. — get_detections","text":"","code":"# Retrieve a list of detections for project '017_neeri' that occurred in March (month=3) if (FALSE) { # \\dontrun{ get_detections(project_name = \"017_neeri\", datetime__month = 3) } # }"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalprojects.html","id":null,"dir":"Reference","previous_headings":"","what":"Get historical projects list. — get_historicalprojects","title":"Get historical projects list. — get_historicalprojects","text":"Wrapper around 'historicalprojects_list' endpoint retrieve list historical projects based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalprojects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get historical projects list. — get_historicalprojects","text":"","code":"get_historicalprojects(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalprojects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get historical projects list. — get_historicalprojects","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalprojects_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalprojects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get historical projects list. — get_historicalprojects","text":"dataframe containing historical projects match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalprojects_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalprojects.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get historical projects list. — get_historicalprojects","text":"","code":"# retrieve a dataframe of all historical projects if (FALSE) get_historicalprojects() # \\dontrun{} # Retrieve a list of projects that contain 'red_panda' or 'green_banana' in their name if (FALSE) get_historicalprojects(project_name__in = \"red_panda, green_banana\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecordergroups.html","id":null,"dir":"Reference","previous_headings":"","what":"Get historical recorder groups list. — get_historicalrecordergroups","title":"Get historical recorder groups list. — get_historicalrecordergroups","text":"Wrapper around 'historicalrecordergroups_list' endpoint retrieve list recorder groups based specified query parameters. contains configurations species list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecordergroups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get historical recorder groups list. — get_historicalrecordergroups","text":"","code":"get_historicalrecordergroups(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecordergroups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get historical recorder groups list. — get_historicalrecordergroups","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalrecordergroups_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecordergroups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get historical recorder groups list. — get_historicalrecordergroups","text":"list containing historical recorder groups match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalrecordergroups_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecordergroups.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get historical recorder groups list. — get_historicalrecordergroups","text":"","code":"# Retrieve a data frame of historical recorder groups for project 'oekofor' if (FALSE) get_historicalrecordergroups(project_name = \"oekofor\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecorders.html","id":null,"dir":"Reference","previous_headings":"","what":"Get historical recorders list. — get_historicalrecorders","title":"Get historical recorders list. — get_historicalrecorders","text":"Wrapper around 'historicalrecorders_list' endpoint get list recorders based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecorders.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get historical recorders list. — get_historicalrecorders","text":"","code":"get_historicalrecorders(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecorders.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get historical recorders list. — get_historicalrecorders","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalrecorders_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecorders.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get historical recorders list. — get_historicalrecorders","text":"dataframe containing historical recorders match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_historicalrecorders_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_historicalrecorders.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get historical recorders list. — get_historicalrecorders","text":"","code":"# Retrieve a list of historical recorders for project '017_neeri' if (FALSE) get_historicalrecorders(project_name = \"017_neerach_ried\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_mediafile.html","id":null,"dir":"Reference","previous_headings":"","what":"Get media file. — get_mediafile","title":"Get media file. — get_mediafile","text":"Wrapper around 'detections_media_retrieve' endpoint retrieve media file detection.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_mediafile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get media file. — get_mediafile","text":"","code":"get_mediafile(uid)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_mediafile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get media file. — get_mediafile","text":"uid uid specifiy detection. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_detections_media_retrieve","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_mediafile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get media file. — get_mediafile","text":"object type \"httr2_response\". contains raw data body (currently audio image)","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_mediafile.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get media file. — get_mediafile","text":"","code":"if (FALSE) get_mediafile(\"c8c155f9-c05b-4e86-b842-88b80829e36c\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Get project info. — get_project_info","title":"Get project info. — get_project_info","text":"Wrapper around 'projects_retrieve' endpoint retrieve information specific project.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get project info. — get_project_info","text":"","code":"get_project_info(project_name)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get project info. — get_project_info","text":"project_name Name project.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get project info. — get_project_info","text":"list containing information specified project: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_projects_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get project info. — get_project_info","text":"function retrieves information specific project, based project name provided 'project_name' parameter.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_project_info.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get project info. — get_project_info","text":"","code":"# Retrieve information about the '017_neeri' project if (FALSE) get_project_info(project_name = \"017_neeri\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_projects.html","id":null,"dir":"Reference","previous_headings":"","what":"Get projects list. — get_projects","title":"Get projects list. — get_projects","text":"Wrapper around 'projects_list' endpoint retrieve list projects based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_projects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get projects list. — get_projects","text":"","code":"get_projects(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_projects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get projects list. — get_projects","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_projects_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_projects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get projects list. — get_projects","text":"dataframe containing projects match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_projects_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_projects.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get projects list. — get_projects","text":"","code":"# retrieve a dataframe of all projects if (FALSE) get_projects() # \\dontrun{} # Retrieve a list of projects that contain 'red_panda' or 'green_banana' in their name if (FALSE) get_projects(project_name__in = \"red_panda, green_banana\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html","id":null,"dir":"Reference","previous_headings":"","what":"Get recorder groups list. — get_recordergroups","title":"Get recorder groups list. — get_recordergroups","text":"Wrapper around 'recordergroups_list' endpoint retrieve list recorder groups based specified query parameters. contains configurations species list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get recorder groups list. — get_recordergroups","text":"","code":"get_recordergroups(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get recorder groups list. — get_recordergroups","text":"... query paramaters. Leave empty get recordergroups. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recordergroups_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get recorder groups list. — get_recordergroups","text":"list containing recorder groups match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recordergroups_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get recorder groups list. — get_recordergroups","text":"","code":"# Retrieve a data frame of recorder groups for project 'oekofor' if (FALSE) get_recordergroups(project_name = \"oekofor\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderlogs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get recorder logs list. — get_recorderlogs","title":"Get recorder logs list. — get_recorderlogs","text":"Wrapper around 'recorderlogs_list' endpoint retrieve list recorder logs based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderlogs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get recorder logs list. — get_recorderlogs","text":"","code":"get_recorderlogs(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderlogs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get recorder logs list. — get_recorderlogs","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderlogs_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderlogs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get recorder logs list. — get_recorderlogs","text":"dataframe containing recorder logs match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderlogs_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderlogs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get recorder logs list. — get_recorderlogs","text":"","code":"# Retrieve a dataframe of recorder logs for project '017_neeri' if (FALSE) get_recorderlogs(project_name = \"017_neeri\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":null,"dir":"Reference","previous_headings":"","what":"Get recorders list. — get_recorders","title":"Get recorders list. — get_recorders","text":"Wrapper around 'recorders_list' endpoint retrieve list recorders based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get recorders list. — get_recorders","text":"","code":"get_recorders(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get recorders list. — get_recorders","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorders_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get recorders list. — get_recorders","text":"dataframe containing recorders match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorders_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorders.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get recorders list. — get_recorders","text":"","code":"# Retrieve a list of recorders for project '017_neeri' if (FALSE) get_recorders(project_name = \"017_neerach_ried\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderspeciescounts.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a count of detections per clas and recorder for a specific project. — get_recorderspeciescounts","title":"Get a count of detections per clas and recorder for a specific project. — get_recorderspeciescounts","text":"Wrapper around 'meta_project_detections_recorderspeciescounts_retrieve' endpoint retrieve count species detections recorder given project.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderspeciescounts.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a count of detections per clas and recorder for a specific project. — get_recorderspeciescounts","text":"","code":"get_recorderspeciescounts(project_name, ...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderspeciescounts.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a count of detections per clas and recorder for a specific project. — get_recorderspeciescounts","text":"project_name Name project get count detetcions class recorder ... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_meta_project_detections_recorderspeciescounts_retrieve","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderspeciescounts.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a count of detections per clas and recorder for a specific project. — get_recorderspeciescounts","text":"summary containing species counts per recorder within project match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_meta_project_detections_recorderspeciescounts_retrieve.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderspeciescounts.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a count of detections per clas and recorder for a specific project. — get_recorderspeciescounts","text":"","code":"# Retrieve a count pre species and recorders. By default, the count is returned for today if (FALSE) get_recorderspeciescounts(project_name = \"039_zitro\") # \\dontrun{} # You can specify a start_date and end_date to get a count for specific time interval. # Limit 'countable' detections by setting a confidence threshold if (FALSE) get_recorderspeciescounts(project_name = \"039_zitro\", start_date = \"2023-01-01\", end_date = \"2023-12-31\", min_confidence = 0.85) # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html","id":null,"dir":"Reference","previous_headings":"","what":"Get recorder states list. — get_recorderstates","title":"Get recorder states list. — get_recorderstates","text":"Wrapper around 'recorderstates_list' endpoint retrieve list recorder states based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get recorder states list. — get_recorderstates","text":"","code":"get_recorderstates(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get recorder states list. — get_recorderstates","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderstates_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get recorder states list. — get_recorderstates","text":"dataframe containing recorder states match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorderstates_list.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get recorder states list. — get_recorderstates","text":"","code":"# Retrieve all recorder states if (FALSE) get_recorderstates() # \\dontrun{} # Retrieve a list of recorder states for recorder '00000000d76d0bf9' if (FALSE) get_recorderstates(recorder_name = \"00000000d76d0bf9\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordings.html","id":null,"dir":"Reference","previous_headings":"","what":"Get recordings list. — get_recordings","title":"Get recordings list. — get_recordings","text":"Wrapper around 'recordings_list' endpoint retrieve dataframe recordings based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordings.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get recordings list. — get_recordings","text":"","code":"get_recordings(...)"},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordings.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get recordings list. — get_recordings","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recordings_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordings.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get recordings list. — get_recordings","text":"data.frame containing recordings match specified query parameters: https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recordings_list","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/get_recordings.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get recordings list. — get_recordings","text":"","code":"# Retrieve a list of recordings for project '017_neeri' that occurred in March (month=3) if (FALSE) get_recordings(project_name = \"017_neeri\", datetime__month = 3) # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_detections.html","id":null,"dir":"Reference","previous_headings":"","what":"PATCH detection — patch_detections","title":"PATCH detection — patch_detections","text":"Wrapper around 'detections_partial_update' endpoint update detections parameters based specified query parameters.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_detections.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PATCH detection — patch_detections","text":"","code":"patch_detections(..., id_or_uid)"},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_detections.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PATCH detection — patch_detections","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_detections_partial_update id_or_uid database ID UID respective detection","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_detections.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"PATCH detection — patch_detections","text":"httr2_response","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_detections.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"PATCH detection — patch_detections","text":"","code":"# Update the parameter confirmed of an example detection if (FALSE) patch_detections(id_or_uid = \"64733fbc-7cc8-49f6-adf1-c9ec2d676959\", confirmed = \"YES\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_recorders.html","id":null,"dir":"Reference","previous_headings":"","what":"PATCH recorder. — patch_recorders","title":"PATCH recorder. — patch_recorders","text":"Wrapper around 'recorders_partial_update' endpoint update recorders parameters based specified body schema.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_recorders.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PATCH recorder. — patch_recorders","text":"","code":"patch_recorders(..., recorder_name, new_data, file_path)"},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_recorders.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PATCH recorder. — patch_recorders","text":"... query paramaters. See https://api.ecopi.de/api/docs/#tag/v0.1/operation/v0.1_recorders_partial_update. recorder_name name recorder update information . file_path Path file upload.","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_recorders.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"PATCH recorder. — patch_recorders","text":"httr2_response","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/patch_recorders.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"PATCH recorder. — patch_recorders","text":"","code":"# Update the parameter description of the recorder 00041aefd7jgg1014 if (FALSE) patch_recorders(recorder_name = \"008041aefd7ee1015\", description = \"This a recorder ...\", lat = 48) # \\dontrun{} # OR with image if (FALSE) patch_recorders(recorder_name = \"00041aefd7jgg1014\", description = \"Teeeest ...\", lat = 48, file_path = \"/sample_path/sample.jpeg\") # \\dontrun{}"},{"path":"https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert response body to data frame — resp_body_json_to_df","title":"Convert response body to data frame — resp_body_json_to_df","text":"Convert response body data frame","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert response body to data frame — resp_body_json_to_df","text":"","code":"resp_body_json_to_df(api_response)"},{"path":"https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert response body to data frame — resp_body_json_to_df","text":"api_response Response API","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert response body to data frame — resp_body_json_to_df","text":"Data frame","code":""},{"path":"https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert response body to data frame — resp_body_json_to_df","text":"","code":"if (FALSE) { # \\dontrun{ response <- ecopi_api(\"GET /detections/\", params = list(\"project\" = \"017_neeri\")) resp_body_json_to_df(response) } # }"}] diff --git a/sitemap.xml b/sitemap.xml index a0dfcd7..f04f1ea 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -13,12 +13,14 @@ https://oekofor.github.io/ecopiapi/reference/get_project_info.html https://oekofor.github.io/ecopiapi/reference/get_projects.html https://oekofor.github.io/ecopiapi/reference/get_recordergroups.html +https://oekofor.github.io/ecopiapi/reference/get_recorderlogs.html https://oekofor.github.io/ecopiapi/reference/get_recorders.html https://oekofor.github.io/ecopiapi/reference/get_recorderspeciescounts.html https://oekofor.github.io/ecopiapi/reference/get_recorderstates.html https://oekofor.github.io/ecopiapi/reference/get_recordings.html https://oekofor.github.io/ecopiapi/reference/index.html https://oekofor.github.io/ecopiapi/reference/patch_detections.html +https://oekofor.github.io/ecopiapi/reference/patch_recorders.html https://oekofor.github.io/ecopiapi/reference/resp_body_json_to_df.html