get_acoustic_stationary_report: Build Report .html file for Acoustic Stationary Project Data

In talbertc-usgs/NABatR: R Tools for Accessing and Manipulating North American Bat Monitoring Data

Description

Using the outputs from get_projects(), get_project_surveys(), get_acoustic_bulk_wavs(), and get_observed_nights() this function will create a report .html file to an output_dir. This function can run with these outputs or without.

Usage

get_acoustic_stationary_report(
  token,
  project_id,
  output_dir,
  output_type = "html",
  project_name = NULL,
  project_description = NULL,
  file_name = "report.html",
  nightly_plots_type = "grts",
  survey_df = NULL,
  acoustic_bulk_df = NULL,
  nightly_observed_list = NULL,
  num_plots = NULL
)

Arguments

token	String token created from get_nabat_gql_token function
project_id	String or Integer project id from NABat ex: 105 or '105'
output_dir	String output directory to save report .html file ex: /path/to/directory
file_name	(optional) String output file name ex: 'my_report.html' ex: my_report.html
nightly_plots_type	(optional) String 'grts' | 'sites'
survey_df	(optional) Dataframe from running get_project_surveys()
acoustic_bulk_df	(optional) Dataframe from running get_acoustic_bulk_wavs()
nightly_observed_list	(optional) List from running get_observed_nights()
num_plots	(optional) Integer for number of plots. Ex: any number from 0 to 60
manual_nights_df	(optional) Dataframe from running get_observed_nights()
auto_nights_df	(optional) Dataframe from running get_observed_nights()

Examples

## Not run: 
get_acoustic_stationary_report(token      = 'generated-nabat-gql-token',
                               output_dir = '/path/to/your/output/directory',
                               file_name  = 'report.html',
                               project_id = 'number or string of a number')

## End(Not run)

talbertc-usgs/NABatR documentation built on April 22, 2020, 8:23 p.m.