Difference between revisions of "Template:PhoneHomeParameters"

From Genome Analysis Wiki
Jump to navigationJump to search
 
(5 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
See [[PhoneHome]] for more information on how PhoneHome works and what it does.
 
See [[PhoneHome]] for more information on how PhoneHome works and what it does.
  
{{{hdr|==}}}= Turn off PhoneHome (<code>--noPhoneHome</code>) {{{hdr|==}}}=
+
{{#if: {{{bullet|}}} |*<code>--noPhoneHome</code> disables PhoneHome.
Use the <code>--noPhoneHome</code> option to completely disable PhoneHome.  PhoneHome is enabled by default based on the [[#Adjust the Frequency of PhoneHome (--phoneHomeThinning)|thinning parameter]].
+
|{{{hdr|==}}}= Turn off PhoneHome (<code>--noPhoneHome</code>) {{{hdr|==}}}=
 +
Use the <code>--noPhoneHome</code> option to completely disable PhoneHome.}} PhoneHome is enabled by default based on the [[#Adjust the Frequency of PhoneHome (--phoneHomeThinning)|thinning parameter]].
  
 
+
{{#if: {{{bullet|}}} |*<code>--phoneHomeThinning</code> (0-100) adjusts the frequency of PhoneHome.
{{{hdr|==}}}= Adjust the Frequency of PhoneHome (<code>--phoneHomeThinning</code>) {{{hdr|==}}}=
+
|{{{hdr|==}}}= Adjust the Frequency of PhoneHome (<code>--phoneHomeThinning</code>) {{{hdr|==}}}=
By default, when PhoneHome is enabled (default), it only happens a certain percentage of the time.
+
Use <code>--phoneHomeThinning</code> to modify the percentage of the time that PhoneHome will run (0-100).}}
 
+
{{#if: {{{bullet|}}} |*|}}*By default, <code>--phoneHomeThinning</code> is set to {{{thin|50}}}, running {{{thin|50}}}% of the time.   
Use <code>--phoneHomeThinning</code> to modify the percentage of the time that PhoneHome will run (0-100). By default, <code>--phoneHomeThinning</code> is set to 50.   
+
{{#if: {{{bullet|}}} |*|}}*PhoneHome will only occur if the run's random number modulo 100 is less than the --phoneHomeThinning value.
 
+
{{#if: {{{bullet|}}} |*|}}*N/A if <code>--noPhoneHome</code> is set.
PhoneHome will only occur if the run's random number modulo 100 is less than the --phoneHomeThinning value.
 
 
 
N/A if <code>--noPhoneHome</code> is set.
 

Latest revision as of 14:58, 17 February 2014

PhoneHome Parameters

See PhoneHome for more information on how PhoneHome works and what it does.

Turn off PhoneHome (--noPhoneHome)

Use the --noPhoneHome option to completely disable PhoneHome. PhoneHome is enabled by default based on the thinning parameter.

Adjust the Frequency of PhoneHome (--phoneHomeThinning)

Use --phoneHomeThinning to modify the percentage of the time that PhoneHome will run (0-100).

  • By default, --phoneHomeThinning is set to 50, running 50% of the time.
  • PhoneHome will only occur if the run's random number modulo 100 is less than the --phoneHomeThinning value.
  • N/A if --noPhoneHome is set.