lmpy.tools.clean_occurrences

This tool cleans occurrence records according to the wranglers specified.

Module Contents

Functions

clean_data(reader, writer_filename, wranglers, write_fields=None, log_output=False)

Clean occurrence data.

cli()

A command-line interface to the tool.
lmpy.tools.clean_occurrences.clean_data(reader, writer_filename, wranglers, write_fields=None, log_output=False)[source]

Clean occurrence data.

Parameters

  • reader (PointCsvReader) – A reader object that generates Point objects.

  • writer_filename (str) – A file location to write cleaned points.

  • wranglers (list of Wranglers) – A list of data wranglers that manipulate and / or filter Points for cleaning.

  • write_fields (list or None) – A list of Point attributes to write to output CSV. If None, determine from first cleaned Point.

  • log_output (bool) – Should output be logged to console.

Returns

Output report from data wrangling.

Return type

dict

lmpy.tools.clean_occurrences.cli()[source]

A command-line interface to the tool.