Derivation named by a describing file#

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

As shipped, suggests nothing: set to read the time, two files a script, a notebook, a log, a protocol or notes mentions would be suggested as one made from the other, the earlier first.

derivation_named_by_a_describing_file version 2

  • 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: derives, named processed_from

  • 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

"earliest_first"

one of earliest_first, undirected

The earlier file as the source.

tolerance_seconds

60

whole number, from 0 to 86400

How far apart the two files’ earliest credible times must be before the earlier is read as the source.

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

The file types whose files describe a process: scripts, notebooks, macros, an analysis workspace and a run’s log.

minimum_resolution

"unique_suffix"

one of exact, unique_suffix, unique_basename, ambiguous

How firmly each end must have been named. A path matched only by its last name places a pair and licenses no derivation.

describing_roles

["protocol", "notes"]

list of text

The roles a named file may play that describe a process. Metadata is left out: a sidecar names its data and describes no step.

stage_transitions

{"acquisition": "processed", "analysis": "quantification", "processed": "analysis", "quantification": "summary", "raw": "processed"}

mapping of text to text

Which stage may follow which: a step agreeing with the order corroborates it, and none is needed.