Technical Description

External Symbols

External Functions

  • External Function: array-fas :function:

    • Syntax

      (array-fas graph &optional (verbose t))

    • Description

      Estimate the feedback arc set of GRAPH using the method of Eades et al. 1993.

  • External Function: read-configuration-from-files :function:

    • Syntax

      (read-configuration-from-files verbose &rest file-names)

    • Arguments

      verbose

      Boolean.
      file-names
      One or more strings or pathnames.

    • Returns

      A configuration.

    • Description

      Reads the initialization files FILE-NAMES and returns a configuration. Errors out if one or more initialization files were not read. If VERBOSE is non-nil, prints a status message.

    • Example

      (read-configuration-from-files t "my-config.ini")

  • External Function: reset-option :function:

    • Syntax

      (reset-option seq section-name option-name value)

    • Arguments

      seq

      An archaeological sequence.
      section-name
      A string.
      option-name
      A string.
      value
      A string.

    • Returns

      Nothing. Called for its side-effects.

    • Description

      Assign a value, VALUE, to the option, OPTION-NAME, in configurations section, SECTION-NAME, in the configuration associated with the archaeological sequence, SEQ. Ensures section and option names are not inadvertently created when resetting an option.

    • Example

      (reset-option *my-sequence* "General configuration" "chronology-graph-draw" "no")

  • External Function: run-project :function:

    • Syntax

      (run-project cfg-file &key (verbose t) (sequence-display png)
             (chronology-display png) (sequence-cmd xdg-open)
             (chronology-cmd xdg-open) (draw-sequence t) (draw-chronology t)
             (delete-sequence nil) (delete-chronology nil))

    • Arguments

      cfg-file

      A string or pathname.
      verbose
      Boolean.
      sequence-display
      A string indicating a Graphviz dot output file format.
      chronology-display
      A string indicating a Graphviz dot output file format.
      sequence-cmd
      A string naming the application used to open the sequence graph.
      chronology-cmd
      A string naming the application used to open the chronology graph.
      draw-sequence
      Boolean.
      draw-chronology
      Boolean.
      delete-sequence
      Boolean. Delete the sequence graph file after it is displayed.
      delete-chronology
      Boolean. Delete the chronology graph file after it is displayed.

    • Returns

      An archaeological sequence.

    • Description

      Run the project specified in the user’s configuration file, CFG-FILE. If DRAW-SEQUENCE is non-nil, then create a sequence graph in the format indicated by SEQUENCE-DISPLAY and open the graphics file with the shell command, SEQUENCE-CMD. If DELETE-SEQUENCE is non-nil, then delete the graphics file after it is displayed. If DRAW-CHRONOLOGY is non-nil, then create a sequence graph in the format indicated by CHRONOLOGY-DISPLAY and open the graphics file with the shell command, CHRONOLOGY-CMD. If DELETE-CHRONOLOGY is non-nil, then delete the graphics file after it is displayed. If VERBOSE is non-nil, then advertise progress.

    • Example

      (run-project "my-config.ini" :verbose nil :sequence-cmd "evince")

  • External Function: run-project/example :function:

    • Syntax

      (run-project/example example &key (verbose t) (sequence-display png)
                     (chronology-display png) (sequence-cmd xdg-open)
                     (chronology-cmd xdg-open) (draw-sequence t)
                     (draw-chronology t) (delete-sequence t)
                     (delete-chronology t))

    • Arguments

      example

      A keyword, one of :catal-hoyuk, :catal-hoyuk-levels, :catal-hoyuk-distance, :roskams-h, :roskams-h-solarized-light, :roskams-h-solarized-dark, :roskams-jumps, :complex-h-structure, :complex-h-structure-reachable, :fig-12, :fig-12-correlations, :fig-12-periods.
      verbose
      Boolean.
      sequence-display
      A string indicating a Graphviz dot output file format.
      chronology-display
      A string indicating a Graphviz dot output file format.
      sequence-cmd
      A string naming the application used to open the sequence graph.
      chronology-cmd
      A string naming the application used to open the chronology graph.
      draw-sequence
      Boolean.
      draw-chronology
      Boolean.
      delete-sequence
      Boolean. Delete the sequence graph file after it is displayed.
      delete-chronology
      Boolean. Delete the chronology graph file after it is displayed.

    • Returns

      An archaeological sequence.

    • Description

      Given a keyword, EXAMPLE, that indicates one of the example projects defined for the hm package, run the project described by the appropriate .ini file.

    • Example

      (run-project/example :roskams-h :delete-sequence nil)

  • External Function: set-input-file :function:

    • Syntax

      (set-input-file seq option file-name header)

    • Arguments

      seq

      An archaeological sequence.
      option
      A string.
      file-name
      A string or pathname.
      header
      Boolean

    • Returns

      Nothing. Called for its side-effects.

    • Description

      If OPTION is recognized, then FILE-NAME and HEADER are registered with the configuration associated with the archaeological sequence, SEQ. HEADER is interpreted as a boolean.

    • Example

      (set-input-file "contexts" "roskams-h-contexts.ini" t)

  • External Function: set-output-file :function:

    • Syntax

      (set-output-file seq option file-name &optional (verbose t))

    • Arguments

      seq

      An archaeological sequence.
      option
      A string.
      file-name
      A string or pathname.
      verbose
      Boolean.

    • Returns

      Nothing. Called for its side-effects.

    • Description

      Registers the output file, FILE-NAME, with the OPTION in the configuration associated with the archaeological sequence, SEQ. Checks if OPTION is known and errors out if not. If FILE-NAME exists and VERBOSE is non-nil, then asks about overwriting it.

    • Example

      (set-output-file *my-seq* "observations" "my-observations.csv")

  • External Function: show-classifiable-attributes :function:

    • Syntax

      (show-classifiable-attributes)

    • Arguments

      None.

    • Returns

      Nothing. Called for its side-effects.

    • Description

      Write a list of classifiable attributes to standard output.

    • Example

      (show-classifiable-attributes)

  • External Function: show-classifiers :function:

    • Syntax

      (show-classifiers)

    • Arguments

      None.

    • Returns

      Nothing. Called for its side effects.

    • Description

      Write a list of classifiers to standard output.

    • Example

      (show-classifiers)

  • External Function: show-configuration-options :function:

    • Syntax

      (show-configuration-options seq section)

    • Arguments

      seq

      An archaeological sequence.
      section
      A string.

    • Returns

      A list of strings.

    • Description

      Print the options in section SECTION of configuration associated with the archaeological sequence, SEQ. Errors out if the configuration is not valid or SECTION isn’t found in the configuration.

    • Example

      (show-configuration-options *my-sequence* "General configuration")

  • External Function: show-configuration-sections :function:

    • Syntax

      (show-configuration-sections seq &optional (sort t))

    • Arguments

      seq

      An archaeological sequence.
      sort
      Boolean.

    • Returns

      A list of strings.

    • Description

      Print out the sections in the configuration associated with the archaeological sequence, SE, by default in sorted order. If SORT is nil, then print out the unsorted section list. Errors out if the configuration associated with SEQ is not valid.

    • Example

      (show-configuration-sections *my-sequence* nil)

  • External Function: show-map :function:

    • Syntax

      (show-map attribute)

    • Arguments

      A keyword, ATTRIBUTE, one of :edge-style, :node-style, :node-shape, or :arrow-shape.

    • Returns

      Nothing. Called for its side-effects

    • Description

      Write a lookup map of attributes to standard output. Raise an error if ATTRIBUTES is out of range.

    • Example

      (show-map :edge-style)

  • External Function: write-classifier :function:

    • Syntax

      (write-classifier classifier-type seq &optional (verbose t))

    • Arguments

      classifier-type

      A keyword.
      seq
      An archaeological sequence.
      verbose
      Boolean.

    • Returns

      Nothing. Called for its side-effects.

    • Description

      Write the classifier, CLASSIFIER-TYPE, to a file specified in the user’s configuration stored in the archaeological sequence, SEQ. If verbose, indicate that a file was written.

    • Example

      (write-classifier :levels *my-sequence* nil)

  • External Function: write-configuration :function:

    • Syntax

      (write-configuration seq file-name)

    • Arguments

      seq

      An archaeological sequence.
      file-name
      A string or pathname.

    • Returns

      Nothing. Called for its side-effects.

    • Description

      Write configuration associated with the archaeological sequence, SEQ, to the file, FILE-NAME, in the project directory associated with SEQ.

    • Example

      (write-configuration *my-sequence* "my-config.ini")

  • External Function: write-default-configuration :function:

    • Syntax

      (write-default-configuration file-name)

    • Argument

      file-name

      A string or pathname.

    • Returns

      Nothing. Called for its side-effects.

    • Description

      Write the default configuration to the file, FILE-NAME. Returns an error if the directory part of FILE-NAME cannot be found.

    • Example

      (write-default-configuration <path/to/default-config.ini>)

Index

A R S W

A

R

S

W

Colophon

This section of the documentation was generated from Common Lisp source code using a hacked up copy of CLOD, version 1.0. The latest version of CLOD is available here.