Module analyzer

Module analyzer 

Source
Expand description

§Prose analyzer module

This is where we keep functions and interfaces necessary to execute ACORN’s automated editorial style guide as well as content readability analyzer.

Modules§

readability
Readability utilities
vale
Vale interface

Structs§

Check
Data structure for holding the result of a schema validation check
CheckBuilder
Use builder syntax to set the inputs and finish with build().

Enums§

CheckCategory
Various check categories available for validating research activity data
ErrorKind
Error kind

Traits§

IntoRow
Trait for converting to a (Polars) row
StaticAnalyzer
Trait for static analyzers (e.g. Vale)
StaticAnalyzerConfig
Trait for static analyzer configuration (e.g. .vale.ini)

Functions§

checks_to_dataframe
Convert vector of Check values to a Polars [DataFrame]
convert_lychee_response
Convert Lychee response to Check
link_check
Perform link check on given URL using Lychee
pretty_print
Prints text to stdout using syntax highlighting for the specified syntax.
summary
Create summary data table from given issues
to_dataframe
Convert vector of values of a given type to a Polars DataFrame