Commit 49262f4d authored by Archana Bidargaddi's avatar Archana Bidargaddi
Browse files

updated tabulate command documentation with options missing and nolabel

parent 1cc7a490
...@@ -4,6 +4,29 @@ ...@@ -4,6 +4,29 @@
function CommandExecutor() { function CommandExecutor() {
"use strict"; "use strict";
var helpTexts = { var helpTexts = {
"ci": {
"parameters": "varlist [, options]",
"shortDescription": "Displays confidence intervals and standard errors for the variables.",
"description": "The command ci displays standard errors and confidence intervals for each of the variables in varlist.",
"syntax": "ci varlist [, options]",
"examples": [
{
"example": "ci income2004",
"description": "Displays confidence intervals with default level set at 95% and standard errors for the variable income2004."
},
{
"example": "ci income2004 income2003 , level(90)",
"description": "Displays confidence intervals with level set at 90% and standard errors for the variable income2004 and income2003"
}
],
"options" : [
{
"name" : "level(#)",
"shortDescription" : "Set confidence level; default is level(95)",
"description" : "Specifies the confidence level, as a percentage, for confidence intervals. The default is set at 95% and can be set to desired via this."
}
]
},
"correlate": { "correlate": {
"parameters": "varlist [if]", "parameters": "varlist [if]",
"shortDescription": "Generates a correlation matrix.", "shortDescription": "Generates a correlation matrix.",
...@@ -64,7 +87,7 @@ function CommandExecutor() { ...@@ -64,7 +87,7 @@ function CommandExecutor() {
}, },
{ {
"example": "generate fakeVar = age + 5 if gender = 0", "example": "generate fakeVar = age + 5 if gender = 0",
"description": "as above, but only when gender is equal to zero. Value of fakeVar will otherwise be missing" "description": "As above, but only when gender is equal to zero. Value of fakeVar will otherwise be missing"
} }
] ]
}, },
...@@ -108,6 +131,34 @@ function CommandExecutor() { ...@@ -108,6 +131,34 @@ function CommandExecutor() {
} }
] ]
}, },
"regress": {
"parameters": "depvar indepvarlist [, options]",
"shortDescription": "Displays linear regression for the variables.",
"description": "The command regress fits a model of dependent variable on the independent variables using linear regression.",
"syntax": "regress depvar indepvarlist [, options]",
"examples": [
{
"example": "regress income2004 income2003",
"description": "Displays linear regression model for income2004 based on income2003 with default confidence interval level set at 95%."
},
{
"example": "ci income2004 income2003 , level(90)",
"description": "Displays linear regression model for income2004 based on income2003 with confidence interval level set at 90%."
}
],
"options" : [
{
"name" : "noconstant",
"shortDescription" : "Suppress constant term",
"description" : "Suppresses the constant term (the y intercept) in the model"
},
{
"name" : "level(#)",
"shortDescription" : "Set confidence level; default is level(95)",
"description" : "Specifies the confidence level, as a percentage, for confidence intervals. The default is set at 95% and can be set to desired via this."
}
]
},
"summarize": { "summarize": {
"parameters": "varlist [if]", "parameters": "varlist [if]",
"shortDescription": "List summary statistics for variables.", "shortDescription": "List summary statistics for variables.",
...@@ -125,10 +176,10 @@ function CommandExecutor() { ...@@ -125,10 +176,10 @@ function CommandExecutor() {
] ]
}, },
"tabulate": { "tabulate": {
"parameters": "varname1 [varname2] [if]", "parameters": "varname1 [varname2] [if] [, options]",
"shortDescription": "Generate tables of frequencies with one or more variables.", "shortDescription": "Generate tables of frequencies with one or more variables.",
"description": "The command tabulate displays univariant summary statistics of the status variables. When a condition is specified the subset of the cases that match the condition are displayed.", "description": "The command tabulate displays univariant summary statistics of the status variables. When a condition is specified the subset of the cases that match the condition are displayed.",
"syntax": "tabulate varname1 [varname2] [if]", "syntax": "tabulate varname1 [varname2] [if] [, options]",
"examples": [ "examples": [
{ {
"example": "tabulate gender age", "example": "tabulate gender age",
...@@ -139,6 +190,18 @@ function CommandExecutor() { ...@@ -139,6 +190,18 @@ function CommandExecutor() {
"description": "Two-way tabulatiton with a conditional expression." "description": "Two-way tabulatiton with a conditional expression."
} }
] ]
"options" : [
{
"name" : "missing",
"shortDescription" : "Treat missing values like other values",
"description" : "The missing values are treated like any other value in calculations of counts, percentages, and other statistics."
}
{
"name" : "nolabel",
"shortDescription" : "Display numeric codes for the categories rather than value labels",
"description" : "The numeric codes of the categories are requested to be displayed rather than the value labels."
}
]
}, },
"topics": { "topics": {
"parameters": "[topiclist]", "parameters": "[topiclist]",
...@@ -171,58 +234,7 @@ function CommandExecutor() { ...@@ -171,58 +234,7 @@ function CommandExecutor() {
"description": "Displays metadata for the specified register variables." "description": "Displays metadata for the specified register variables."
} }
] ]
}, }
"ci": {
"parameters": "varlist [, options]",
"shortDescription": "Displays confidence intervals and standard errors for the variables.",
"description": "The command ci displays standard errors and confidence intervals for each of the variables in varlist.",
"syntax": "ci varlist [, options]",
"examples": [
{
"example": "ci income2004",
"description": "Displays confidence intervals with default level set at 95% and standard errors for the variable income2004."
},
{
"example": "ci income2004 income2003 , level(90)",
"description": "Displays confidence intervals with level set at 90% and standard errors for the variable income2004 and income2003"
}
],
"options" : [
{
"name" : "level(#)",
"shortDescription" : "set confidence level; default is level(95)",
"description" : "specifies the confidence level, as a percentage, for confidence intervals. The default is set at 95% and can be set to desired via this."
}
]
},
"regress": {
"parameters": "depvar indepvarlist [, options]",
"shortDescription": "Displays linear regression for the variables.",
"description": "The command regress fits a model of dependent variable on the independent variables using linear regression.",
"syntax": "regress depvar indepvarlist [, options]",
"examples": [
{
"example": "regress income2004 income2003",
"description": "Displays linear regression model for income2004 based on income2003 with default confidence interval level set at 95%."
},
{
"example": "ci income2004 income2003 , level(90)",
"description": "Displays linear regression model for income2004 based on income2003 with confidence interval level set at 90%."
}
],
"options" : [
{
"name" : "noconstant",
"shortDescription" : "suppress constant term",
"description" : "suppresses the constant term (the y intercept) in the model"
},
{
"name" : "level(#)",
"shortDescription" : "set confidence level; default is level(95)",
"description" : "specifies the confidence level, as a percentage, for confidence intervals. The default is set at 95% and can be set to desired via this."
}
]
}
}, },
req = new XMLHttpRequest(), req = new XMLHttpRequest(),
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment