Skip to content

Commit 01245a6

Browse files
authored
Clarify use of -D for loading toys (#1201)
* Add comment on using -D to load toys * Small clarification on when to use toysFile * Refer to pickToy option in GenerateOnly section
1 parent e7aa630 commit 01245a6

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/part3/runningthetool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ If you are using `toysFrequentist`, be aware that the values set by `--setParame
207207

208208
It is also possible to generate the toys first, and then feed them to the methods in <span style="font-variant:small-caps;">Combine</span>. This can be done using `-M GenerateOnly --saveToys`. The toys can then be read and used with the other methods by specifying `--toysFile=higgsCombineTest.GenerateOnly...` and using the same options for the toy generation.
209209

210-
You can specify to run on a single toy, in place of the observed data, by including the option `-D file.root:toys/toy_i`. For example adding `-D higgsCombineTest.GenerateOnly.mH120.123456.root:toys/toy_10` will run on the data set `toy_10` (the 10th toy) that was generated and saved in the file `higgsCombineTest.GenerateOnly.mH120.123456.root`.
210+
To run on a specific toy, you can pass the `--toysFile` option, plus the same options for the toy generation, and the option `--pickToy N` to run on the Nth toy. Additionally, for non-frequentist toys, you can specify to run on a single toy, in place of the observed data, by including the option `-D file.root:toys/toy_i`. For example adding `-D higgsCombineTest.GenerateOnly.mH120.123456.root:toys/toy_10` will run on the data set `toy_10` (the 10th toy) that was generated and saved in the file `higgsCombineTest.GenerateOnly.mH120.123456.root`. Note that if you are using frequentist toys, you must use the `--toysFile` option, as by passing the toy as an alternative data set the randomized constraint terms that are part of the frequentist toy generation will not be loaded.
211211

212212
!!! warning
213213
Some methods also use toys within the method itself (eg `AsymptoticLimits` and `HybridNew`). For these, you should **not** specify the toy generation with `-t` or the options above. Instead, you should follow the method-specific instructions.

0 commit comments

Comments
 (0)