build_ac_doc: Build Report document in .docx file for Acoustic Stationary...

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 .docx file to an out_dir.

Usage

build_ac_doc(
  out_dir,
  file_name,
  manual_species_grts_df_w,
  auto_species_grts_df_w,
  project_df,
  project_id,
  acoustic_bulk_df,
  manual_species_totals_l,
  auto_species_totals_l,
  auto_nights_df,
  manual_nights_df,
  cover_photo = NULL,
  date = format(Sys.time(), "%B %d, %Y"),
  map = NULL,
  range_maps = TRUE
)

Arguments

out_dir	String output directory to save report .html file ex: /path/to/directory
file_name	String output file name ex: paste0('doc_report_',project_id_,'_',Sys.Date(),'.docx')
manual_species_grts_df_w	Dataframe from running get_species_counts_wide()
auto_species_grts_df_w	Dataframe from running get_species_counts_wide()
project_df	Dataframe from running get_projects()
project_id	Integer project id from NABat ex: 105
acoustic_bulk_df	Dataframe from running get_observed_nights()
manual_species_totals_l	Dataframe from running get_species_counts_long()
auto_species_totals_l	Dataframe from running get_species_counts_long()
auto_nights_df	Dataframe from running get_observed_nights()
manual_nights_df	Dataframe from running get_observed_nights()
cover_photo	String path to a .png file
date	Date current time in a month/day/Year format ex: format(Sys.time(), " ## Not run: doc_ = build_ac_doc(out_dir = '/path/to/output/dir', file_name = paste0('doc_report_',project_id_,'_',Sys.Date(),'.docx'), project_df = project_df_, manual_species_grts_df_w, auto_species_grts_df_w, project_id = project_id_, auto_nights_df = auto_nights_df_, manual_nights_df = manual_nights_df_, cover_photo = '/path/to/a/cover/photo.png', map = grts_map, manual_species_grts_df_w = manual_species_grts_df_w_, auto_species_grts_df_w = auto_species_grts_df_w_, auto_species_totals_l = auto_species_totals_l_, manual_species_totals_l = manual_species_totals_l_, date = format(Sys.time(), " acoustic_bulk_df = acoustic_bulk_df_) ## End(Not run)
map	(optional) output from get_grts_leaflet_map()

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