Screaming Frog import contract

Returns the frozen contract that governs how Screaming Frog exports are read and normalized: the accepted export kinds, the column schemas (canonical field order, required fields, and header aliases) for the Internal and Inlinks/Outlinks exports, and which link types count as graph-eligible. Inspect it to see exactly which Screaming Frog column headers are recognized before importing a crawl.

Usage

sf_contract()

Value

A list with components:

version

Integer contract version.

bundle_fields

Character vector of the fields present on a screaming_frog_bundle() object.

export_kinds

Character vector of accepted export kinds, used by sf_read_input().

graph_eligible_types

Link types treated as graph edges; see sf_graph_eligible().

internal, links

Schemas for the Internal and Inlinks/Outlinks exports, each a list of order, required, and aliases.

See also

Other Screaming Frog toolkit: sf_container_from_path(), sf_graph_eligible(), sf_normalize_position(), sf_parse_follow(), sf_read_input(), sf_region_from_path(), sf_rel_nofollow()

Examples

contract <- sf_contract()
contract$export_kinds
#> [1] "internal_all" "all_inlinks"  "all_outlinks"
contract$graph_eligible_types
#> [1] "Hyperlink"

# Which Screaming Frog headers map onto the `address` field?
contract$internal$aliases$address
#> [1] "Address" "URL"     "URI"