Related by a describing file#

This page is generated from the code and must not be edited by hand.

Two files a script, a notebook, a log, a protocol or notes mentions are suggested as related, with which, if either, was made from the other not known; never inside an installed program.

related_by_a_describing_file version 1

Kind of rule: Pairs suggested for a look (proposes). Proposes that two files are related in one of the eight ways, for a person to look at. A proposal is never a conclusion.
What it concludes: concerns
Reasoning: defeasible. A conclusion is usually right, and is retracted when a rule it names concludes against it.
What it reads: one file at a time
Where it looks for pairs: within co_mentioned

Is it available in this version?#

Yes. The engine runs it.

What would defeat it#

What this rule concludes about something is withdrawn when any of these rules concludes about the same thing:

installed_software_in_folder: A folder is recognized as an installed program, such as a copy of Fiji or a Python environment, from the parts it holds, a name ending .app, its program-style subfolders or a majority of program files; its files are still indexed and read, and rules about experiments leave them alone.

Parameters#

Parameter	Shipped value	May be	What it does
`ordered_by_time`	`false`	yes or no	Whether the earlier file is read as the source. Off: two inputs of one script were made in turn and neither from the other.
`direction`	`"undirected"`	one of `earliest_first`, `undirected`	Neither file as the source.
`tolerance_seconds`	`60`	whole number, from 0 to 86400	As the derivation named by a describing file reads it.
`describing_formats`	`["python_source", "r_source", "r_markdown", "matlab_source", "shell_script", "perl_source", "notebook_format", "imagej_macro", "flowjo_workspace", "log_file"]`	list of text	As the derivation named by a describing file reads them.
`describing_roles`	`["protocol", "notes"]`	list of text	As the derivation named by a describing file reads them.
`minimum_resolution`	`"unique_suffix"`	one of `exact`, `unique_suffix`, `unique_basename`, `ambiguous`	As the derivation named by a describing file reads it.