Class: UsageTemplate

A container for specifying string substitution templates for usage specification, see Usage class.

Comments

The attributes below can be applied as templates using {{ attr }} notation.
The default values of the listed attributes can be overriden in this way using the specification of supported filetypes, see SupportedFileType class.
For instance, if an extractor supports the example file type, but expects xmpl as an argument:
```
extractor --filetype xmpl inputfile.bla
```
one could set input_type: xmpl here, and specify the following command in the Usage class:
```
extractor --filetype {{ input_type }} {{ input_path }}
```

erDiagram UsageTemplate { string input_path string input_type string output_path string output_type }

Slots

Name	Cardinality and Range	Description	Inheritance
input_path	0..1 String	The location of the resource (e.g., file, or directory) on disk to be extracted. Required.	direct
input_type	0..1 String	The `FileType` of the `input_path`. Defaults to the `FileType->id` for each supported file type.	direct
output_path	0..1 String	The location where the output of the extraction will be written to disk. Defaults to the `Extractor` default.	direct
output_type	0..1 String	The `FileType` of the `output_path`, for `Extractors` supporting multiple output `FileTypes`. Defaults to the `FileType->id` for each supported output file type.	direct

Usages

used by	used in	type	used
SupportedFileType	template	range	UsageTemplate

Identifier and Mapping Information

Schema Source

from schema: https://datatractor.github.io/schema/main/datatractor_schema/

Mappings

Mapping Type	Mapped Value
self	datatractor_schema:UsageTemplate
native	datatractor_schema:UsageTemplate

LinkML Source

Direct

name: UsageTemplate
description: A container for specifying string substitution templates for usage specification,
  [see `Usage` class](Usage.md).
comments:
- The attributes below can be applied as templates using `{{ attr }}` notation.
- The default values of the listed attributes can be overriden in this way using the
  specification of supported filetypes, [see `SupportedFileType` class](SupportedFileType.md).
- "For instance, if an `extractor` supports the `example` file type, but expects `xmpl`\
  \ as an argument:\n\n  ```bash\n  extractor --filetype xmpl inputfile.bla\n  ```\n\
  \n  one could set `input_type: xmpl` here, and specify the following `command`\n\
  in the `Usage` class:\n\n  ```bash\n  extractor --filetype {{ input_type }} {{ input_path\
  \ }}\n  ```"
from_schema: https://datatractor.github.io/schema/main/datatractor_schema/
rank: 1000
attributes:
  input_path:
    name: input_path
    description: The location of the resource (e.g., file, or directory) on disk to
      be extracted. Required.
    from_schema: https://datatractor.github.io/schema/main/datatractor_schema/
    rank: 1000
    domain_of:
    - UsageTemplate
  input_type:
    name: input_type
    description: The `FileType` of the `input_path`. Defaults to the `FileType->id`
      for each supported file type.
    from_schema: https://datatractor.github.io/schema/main/datatractor_schema/
    rank: 1000
    domain_of:
    - UsageTemplate
  output_path:
    name: output_path
    description: The location where the output of the extraction will be written to
      disk. Defaults to the `Extractor` default.
    from_schema: https://datatractor.github.io/schema/main/datatractor_schema/
    rank: 1000
    domain_of:
    - UsageTemplate
  output_type:
    name: output_type
    description: The `FileType` of the `output_path`, for `Extractors` supporting
      multiple output `FileTypes`. Defaults to the `FileType->id` for each supported
      output file type.
    from_schema: https://datatractor.github.io/schema/main/datatractor_schema/
    rank: 1000
    domain_of:
    - UsageTemplate

Induced

name: UsageTemplate
description: A container for specifying string substitution templates for usage specification,
  [see `Usage` class](Usage.md).
comments:
- The attributes below can be applied as templates using `{{ attr }}` notation.
- The default values of the listed attributes can be overriden in this way using the
  specification of supported filetypes, [see `SupportedFileType` class](SupportedFileType.md).
- "For instance, if an `extractor` supports the `example` file type, but expects `xmpl`\
  \ as an argument:\n\n  ```bash\n  extractor --filetype xmpl inputfile.bla\n  ```\n\
  \n  one could set `input_type: xmpl` here, and specify the following `command`\n\
  in the `Usage` class:\n\n  ```bash\n  extractor --filetype {{ input_type }} {{ input_path\
  \ }}\n  ```"
from_schema: https://datatractor.github.io/schema/main/datatractor_schema/
rank: 1000
attributes:
  input_path:
    name: input_path
    description: The location of the resource (e.g., file, or directory) on disk to
      be extracted. Required.
    from_schema: https://datatractor.github.io/schema/main/datatractor_schema/
    rank: 1000
    alias: input_path
    owner: UsageTemplate
    domain_of:
    - UsageTemplate
    range: string
  input_type:
    name: input_type
    description: The `FileType` of the `input_path`. Defaults to the `FileType->id`
      for each supported file type.
    from_schema: https://datatractor.github.io/schema/main/datatractor_schema/
    rank: 1000
    alias: input_type
    owner: UsageTemplate
    domain_of:
    - UsageTemplate
    range: string
  output_path:
    name: output_path
    description: The location where the output of the extraction will be written to
      disk. Defaults to the `Extractor` default.
    from_schema: https://datatractor.github.io/schema/main/datatractor_schema/
    rank: 1000
    alias: output_path
    owner: UsageTemplate
    domain_of:
    - UsageTemplate
    range: string
  output_type:
    name: output_type
    description: The `FileType` of the `output_path`, for `Extractors` supporting
      multiple output `FileTypes`. Defaults to the `FileType->id` for each supported
      output file type.
    from_schema: https://datatractor.github.io/schema/main/datatractor_schema/
    rank: 1000
    alias: output_type
    owner: UsageTemplate
    domain_of:
    - UsageTemplate
    range: string