Add sub function to Spec #32

Horneth · Mar 23, 2016

No description provided.

:-D

link is not correct, should be #string-sub-string-string-string I think

I don't really advertise this much, but I wrote a tool called mdtoc which is useful for stuff like this

$ pip install mdtoc
$ mdtoc SPEC.md

Seems that the size() function link might be wrong too?

bah, I guess I was wrong, but the two headers are still not quite right

-  * [File size(File, \[String\])](#float-sizefile-string)
-  * [File sub(String, String, String)](#string-substring-string-string)
+  * [Float size(File, \[String\])](#float-sizefile-string)
+  * [String sub(String, String, String)](#string-substring-string-string)

Oh nice catch. For the link the way I do it is I create the section, generate an html preview and then use whatever link the anchor points to.

scottfrazer · Mar 24, 2016

Besides the table of contents changes, 👍

implemetations => implementations

That spelling of implementor may be a passing fad?

Do we really want to leave regexes so nebulously specified?

I guess the problem is, the Python equivalent of ~~WDL~~ Cromwell might have a different regex evaluator? I guess it could be made more specific, e.g.:
Details of regex evaluation will depend on the execution engine running the WDL

If not, how much more specific do we want to be ? I personally am no regex expert and I don't have any really strong opinion about which standard we should encourage/enforce :/

Yeah I get that we'll have different impls under the hood, I just worry about setting up incompatibility issues. Maybe not a big deal

occurence => occurrence

eg => e.g.

coereced => coerced

mcovarr · Mar 24, 2016

👍

Horneth referenced this pull request in broadinstitute/cromwell Mar 23, 2016
Merged
Sub engine function Closes #597 #605
3 of 3 tasks complete

Horneth Add sub function to Spec

997daff

Horneth merged commit 00b4629 into develop Mar 24, 2016
1 check passed

1 check passed

code-review/pullapprove Approved by all reviewer groups.
Details

mcovarr deleted the subFunction branch Jul 25, 2017

@@ -2114,6 +2115,42 @@ task example {
      Supported units are KiloByte ("K", "KB"), MegaByte ("M", "MB"), GigaByte ("G", "GB"), TeraByte ("T", "TB") as well as their [binary version](https://en.wikipedia.org/wiki/Binary_prefix) "Ki" ("KiB"), "Mi" ("MiB"), "Gi" ("GiB"), "Ti" ("TiB").
      Default unit is Bytes ("B").
+    +
+    +## String sub(String, String, String)
+    +
+    +Given 3 String parameters `input`, `pattern`, `replace`, this function will replace any occurence matching `pattern` in `input` by `replace`.
+    +`pattern` is expected to be a [regular expression](https://en.wikipedia.org/wiki/Regular_expression). There are different implemetations of regular expression evaluators, different sets of rules etc... This choice is left to the implementor.
+    +
+    +Example 1:
+    +
+    +```wdl
+    +  String chocolike = "I like chocolate when it's late"

@@ -86,6 +86,7 @@
        * [File write_objects(Array\[Object\])](#file-write_objectsarrayobject)
        * [File write_json(mixed)](#file-write_jsonmixed)
        * [File size(File, \[String\])](#float-sizefile-string)
+    +  * [File sub(String, String, String)](#string-substring-string-string)

@@ -2114,6 +2115,42 @@ task example {
      Supported units are KiloByte ("K", "KB"), MegaByte ("M", "MB"), GigaByte ("G", "GB"), TeraByte ("T", "TB") as well as their [binary version](https://en.wikipedia.org/wiki/Binary_prefix) "Ki" ("KiB"), "Mi" ("MiB"), "Gi" ("GiB"), "Ti" ("TiB").
      Default unit is Bytes ("B").
+    +
+    +## String sub(String, String, String)
+    +
+    +Given 3 String parameters `input`, `pattern`, `replace`, this function will replace any occurence matching `pattern` in `input` by `replace`.
+    +`pattern` is expected to be a [regular expression](https://en.wikipedia.org/wiki/Regular_expression). There are different implemetations of regular expression evaluators, different sets of rules etc... This choice is left to the implementor.

@@ -2114,6 +2115,42 @@ task example {
      Supported units are KiloByte ("K", "KB"), MegaByte ("M", "MB"), GigaByte ("G", "GB"), TeraByte ("T", "TB") as well as their [binary version](https://en.wikipedia.org/wiki/Binary_prefix) "Ki" ("KiB"), "Mi" ("MiB"), "Gi" ("GiB"), "Ti" ("TiB").
      Default unit is Bytes ("B").
+    +
+    +## String sub(String, String, String)
+    +
+    +Given 3 String parameters `input`, `pattern`, `replace`, this function will replace any occurence matching `pattern` in `input` by `replace`.

+    +
+    +Given 3 String parameters `input`, `pattern`, `replace`, this function will replace any occurence matching `pattern` in `input` by `replace`.
+    +`pattern` is expected to be a [regular expression](https://en.wikipedia.org/wiki/Regular_expression). There are different implemetations of regular expression evaluators, different sets of rules etc... This choice is left to the implementor.
+    +
+    +Example 1:
+    +
+    +```wdl
+    +  String chocolike = "I like chocolate when it's late"
+    +
+    +  String chocolove = sub(chocolike, "like", "love") # I love chocolate when it's late
+    +  String chocoearly = sub(chocolike, "late", "early") # I like chocoearly when it's early
+    +  String chocolate = sub(chocolike, "late$", "early") # I like chocolate when it's early
+    +}
+    +```
+    +
+    +The sub function will also accept `input` and `replace` parameters that can be coereced to a String (eg File). This can be useful to swap the extension of a filename for example

broadinstitute/wdl

Add sub function to Spec #32

Horneth commented Mar 23, 2016

Horneth referenced this pull request in broadinstitute/cromwell Mar 23, 2016

Sub engine function Closes #597 #605

scottfrazer commented on the diff Mar 24, 2016

scottfrazer and 1 other commented on an outdated diff Mar 24, 2016

scottfrazer commented Mar 24, 2016

mcovarr and 2 others commented on an outdated diff Mar 24, 2016

mcovarr commented on an outdated diff Mar 24, 2016

mcovarr commented on an outdated diff Mar 24, 2016

mcovarr commented Mar 24, 2016

Horneth merged commit `00b4629` into develop Mar 24, 2016
1 check passed

1 check passed

mcovarr deleted the subFunction branch Jul 25, 2017

broadinstitute/wdl

Join GitHub today

Add sub function to Spec #32

Conversation

Horneth commented Mar 23, 2016

Horneth referenced this pull request in broadinstitute/cromwell Mar 23, 2016

scottfrazer commented on the diff Mar 24, 2016

Show 4 comments Hide comments scottfrazer and 1 other commented on an outdated diff Mar 24, 2016

scottfrazer commented Mar 24, 2016

Show 4 comments Hide comments mcovarr and 2 others commented on an outdated diff Mar 24, 2016

Show 1 comment Hide comment mcovarr commented on an outdated diff Mar 24, 2016

Show 2 comments Hide comments mcovarr commented on an outdated diff Mar 24, 2016

mcovarr commented Mar 24, 2016

Hide details View details Horneth merged commit 00b4629 into develop Mar 24, 2016 1 check passed

1 check passed

mcovarr deleted the subFunction branch Jul 25, 2017

scottfrazer and 1 other commented on an outdated diff Mar 24, 2016

mcovarr and 2 others commented on an outdated diff Mar 24, 2016

mcovarr commented on an outdated diff Mar 24, 2016

mcovarr commented on an outdated diff Mar 24, 2016

Horneth merged commit `00b4629` into develop Mar 24, 2016
1 check passed