From a3c4a2db8d66c395ad9abd3e55f239a2837d5813 Mon Sep 17 00:00:00 2001 From: Adam Morris Date: Wed, 15 Mar 2017 20:49:45 +0000 Subject: [PATCH] readme --- README.md | 21 ++++----------------- 1 file changed, 4 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 3624bba..7ad3ad2 100644 --- a/README.md +++ b/README.md @@ -55,30 +55,17 @@ Command line option | Description `--NToys` (default 1000) | number of toys per point `--NWorkers` (default 0) | number of worker for ProofLite (default use all available cores) `--RandomSeed` (default -1) | random seed (if = -1: use default value, if = 0 always random ) NOTE: Proof uses automatically a random seed -`--Rebuild` (default 0) | re-do extra toys for computing expected limits and rebuild test stat distributions (N.B this requires much more CPU - | (factor is equivalent to nToyToRebuild) +`--Rebuild` (default 0) | re-do extra toys for computing expected limits and rebuild test stat distributions (N.B this requires much more CPU (factor is equivalent to nToyToRebuild) `--NToyToRebuild` (default 100) | number of toys used to rebuild -`--RebuildParamValues` (default 0) | = 0 do a profile of all the parameters on the B (alt snapshot) before performing a rebuild operation (default) - | = 1 use initial workspace parameters with B snapshot values - | = 2 use all initial workspace parameters with B - | Otherwise the rebuild will be performed using [text missing, I assume it works like 2] +`--RebuildParamValues` (default 0) | = 0 do a profile of all the parameters on the B (alt snapshot) before performing a rebuild operation (default)
= 1 use initial workspace parameters with B snapshot values
= 2 use all initial workspace parameters with B
Otherwise the rebuild will be performed using [text missing, I assume it works like 2] `--GenerateBinned` (default 0) | generate binned data sets `--NoSystematics` (default 0) | force all systematics to be off (i.e. set all nuisance parameters as constant to their nominal values) `--Optimize` (default 1) | optimize evaluation of test statistic `--UseNLLOffset` (default 0) | use NLL offset when fitting (this increase stability of fits) `--UseVectorStore` (default 1) | convert data to use new roofit data store -`--CalculatorType` (default 0) | = 0 Freq calculator - | = 1 Hybrid calculator - | = 2 Asymptotic calculator - | = 3 Asymptotic calculator using nominal Asimov data sets (not using fitted parameter values but nominal ones) +`--CalculatorType` (default 0) | = 0 Freq calculator
= 1 Hybrid calculator
= 2 Asymptotic calculator
= 3 Asymptotic calculator using nominal Asimov data sets (not using fitted parameter values but nominal ones) `--NAsimovBins` (default 0) | number of bins in observables used for Asimov data sets (0 is the default and it is given by workspace, typically is 100) -`--TestStatType` (default 2) | = 0 LEP - | = 1 Tevatron - | = 2 Profile Likelihood - | = 3 Profile Likelihood one sided (i.e. = 0 if mu < mu_hat) - | = 4 Profile Likelihood signed ( pll = -pll if mu < mu_hat) - | = 5 Max Likelihood Estimate as test statistic - | = 6 Number of observed event as test statistic +`--TestStatType` (default 2) | = 0 LEP
= 1 Tevatron
= 2 Profile Likelihood
= 3 Profile Likelihood one sided (i.e. = 0 if mu < mu_hat)
= 4 Profile Likelihood signed ( pll = -pll if mu < mu_hat)
= 5 Max Likelihood Estimate as test statistic
= 6 Number of observed event as test statistic `--UseNumberCounting` (default 0) | set to true when using number counting events `--MinimizerType` | minimizer type (default is what is in ROOT::Math::MinimizerOptions::DefaultMinimizerType()