Skip to content

Commit 419fed3

Browse files
committed
link to IRI wikipage; update example modules IRI.
1 parent 68c53bf commit 419fed3

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

v1.0/CommandLineTool.yml

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -708,11 +708,11 @@ $graph:
708708
- name: specs
709709
type: string[]?
710710
doc: |
711-
One or more IRIs identifying resources for installing or
712-
enabling the software named in the `package` field. Implementations may
713-
provide resolvers which map these software identifer IRIs to some
714-
configuration action; or they can use only the name from the `package`
715-
field on a best effort basis.
711+
One or more [IRI](https://en.wikipedia.org/wiki/Internationalized_Resource_Identifier)s
712+
identifying resources for installing or enabling the software named in
713+
the `package` field. Implementations may provide resolvers which map
714+
these software identifer IRIs to some configuration action; or they can
715+
use only the name from the `package` field on a best effort basis.
716716
717717
For example, the IRI `https://packages.debian.org/bowtie` could
718718
be resolved with `apt-get install bowtie`. The IRI
@@ -725,16 +725,20 @@ $graph:
725725
`https://identifiers.org/rrid/RRID:SCR_005476` could be fulfilled using
726726
the above mentioned Debian or bioconda package, a local installation
727727
managed by [Environement Modules](http://modules.sourceforge.net/), or
728-
any other mechanism the platform chooses.
728+
any other mechanism the platform chooses. If supported by a given
729+
registry, implementations are encouraged to query these system
730+
independent sofware identifier IRIs directly for links to packaging
731+
systems.
729732
730733
A site specific IRI can be listed as well. For example, an academic
731734
computing cluster using Environement Modules could list the IRI
732-
`https://hpc.university.edu/modules/bowtie-tbb/1.22` to indicate that
735+
`https://hpc.example.edu/modules/bowtie-tbb/1.22` to indicate that
733736
`module load bowtie-tbb/1.1.2` should be executed to make available
734-
`bowtie` version 1.1.2 with the TBB library prior to running the
735-
accompanying Workflow or CommandLineTool. Note that the example IRI is
736-
specific to a particular institution and computing environment as the
737-
Environment Modules system does not have a common namespace.
737+
`bowtie` version 1.1.2 compiled with the TBB library prior to running
738+
the accompanying Workflow or CommandLineTool. Note that the example IRI
739+
is specific to a particular institution and computing environment as
740+
the Environment Modules system does not have a common namespace or
741+
standardized naming convention.
738742
739743
This last example is the least portable and should only be used if
740744
mechanisms based off of the `package` field or more generic IRIs are

0 commit comments

Comments
 (0)