Commit 8fdffe17 authored by Feng Xue's avatar Feng Xue
Browse files

remove pwcorr from help text and add anova and replace

parent 41e2c220
...@@ -30,7 +30,7 @@ function CommandExecutor() { ...@@ -30,7 +30,7 @@ function CommandExecutor() {
"correlate": { "correlate": {
"parameters": "varlist [if] [, options]", "parameters": "varlist [if] [, options]",
"shortDescription": "Generates a correlation matrix.", "shortDescription": "Generates a correlation matrix.",
"description": "The correlate command displays the correlation matrix for a group of variables. The varlist is mandatory. ", "description": "The correlate command displays the correlation matrix for a group of variables. The varlist is mandatory. Missing values are by default handled by listwise deletion.",
"syntax": "correlate varlist [if] [, options]", "syntax": "correlate varlist [if] [, options]",
"examples": [ "examples": [
{ {
...@@ -99,8 +99,8 @@ function CommandExecutor() { ...@@ -99,8 +99,8 @@ function CommandExecutor() {
}, },
"generate": { "generate": {
"parameters": "newvar = expression [if ...]", "parameters": "newvar = expression [if ...]",
"shortDescription": "Creates new variable as per the expression defined. CURRENTLY NOT SUPPORTED", "shortDescription": "Creates new variable as per the expression defined.",
"description": "The command generate creates a new variable where its values are as per the expression defined.\n\nThe type of new variable will be determined by the result returned by the expression.\nThe arithmetic functions supported are +, - , *, / and ^ . \n\nCURRENTLY NOT SUPPORTED", "description": "The command generate creates a new variable where its values are as per the expression defined.\n\nThe type of new variable will be determined by the result returned by the expression.\nThe arithmetic functions supported are +, - , *, / and ^ .",
"syntax": "generate newvar =exp [if ...]", "syntax": "generate newvar =exp [if ...]",
"examples": [ "examples": [
{ {
...@@ -108,8 +108,43 @@ function CommandExecutor() { ...@@ -108,8 +108,43 @@ function CommandExecutor() {
"description": "Create a variable called \"fakeVar\". The value for each case will be the value of variable age plus five." "description": "Create a variable called \"fakeVar\". The value for each case will be the value of variable age plus five."
}, },
{ {
"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"
}
]
},
"anova": {
"parameters": "varname termlist [, options]",
"shortDescription": "Analysis of variance and covariance.",
"description": "The anova command fits analysis-of-variance (ANOVA) and analysis-of-covariance (ANCOVA) models for balanced and unbalanced designs. \nThe varlist is mandatory. Termlist is a factor-variable list.",
"syntax": "varname termlist [, options]",
"examples": [
{
"example": "anova gender age income age#income",
"description": "Two-way full factorial anova table of gender on age and income."
}
],
"options" : [
{
"name" : "noconstant",
"shortDescription" : "Suppress constant term",
"description" : "Suppresses the constant term (the y intercept) in the model"
}
]
},
"replace": {
"parameters": "oldvar = expression [if ...]",
"shortDescription": "Create or change contents of variable as per the expression defined.",
"description": " The replace command replace contents of existing variable where its values are as per the expression defined. \n\nThe arithmetic functions supported are +, - , *, / and ^ .",
"syntax": "oldvar = expression [if ...]",
"examples": [
{
"example": "replace var1 = var1 / 2",
"description": "Replace var1 with old one. The value for each case will be the value of old var1 devide 2."
},
{
"example": "replace var1 = var1 / 2 if var2 == 0",
"description": "As above, but only when var2 is equal to zero. Value of var1 will otherwise be missing."
} }
] ]
}, },
...@@ -141,39 +176,6 @@ function CommandExecutor() { ...@@ -141,39 +176,6 @@ function CommandExecutor() {
} }
] ]
}, },
"pwcorr": {
"parameters": "varlist [if] [, options]",
"shortDescription": "Generates pairwise correlation matrix.",
"description": "The pwcorr command displays the pairwise correlation matrix for a group of variables. The varlist is mandatory. Missing values are by default handled by pairwise deletion. ",
"syntax": "pwcorr varlist [if] [, options]",
"examples": [
{
"example": "pwcorr gender age income",
"description": "Three-way pairwise correlation matrix"
},
{
"example": "pwcorr age income if gender == 'male' , obs sig ",
"description": "Two-way pairwise correlation matrix with conditional expression. Number of observations and significance levels are display. "
}
],
"options" : [
{
"name" : "listwise",
"shortDescription" : "Use listwise deletion to handle missing values",
"description" : "Overrides the default pairwise deletion with listwise deletion in handling the missing values."
},
{
"name" : "obs",
"shortDescription" : "Display number of observations for each entry",
"description" : "The matrix includes the number of observations used to calculate the correlation coefficient for each entry."
},
{
"name" : "sig",
"shortDescription" : "Display the level of significance for each entry",
"description" : "The matrix includes the level of significance used to calculate the correlation coefficient for each entry."
}
]
},
"recode": { "recode": {
"parameters": "varlist (rule) [(rule) ...] [, generate(newvar)]", "parameters": "varlist (rule) [(rule) ...] [, generate(newvar)]",
"shortDescription": "Recode categorical variables. CURRENTLY NOT SUPPORTED", "shortDescription": "Recode categorical variables. CURRENTLY NOT SUPPORTED",
...@@ -189,7 +191,7 @@ function CommandExecutor() { ...@@ -189,7 +191,7 @@ function CommandExecutor() {
"regress": { "regress": {
"parameters": "depvar indepvarlist [, options]", "parameters": "depvar indepvarlist [, options]",
"shortDescription": "Displays linear regression for the variables.", "shortDescription": "Displays linear regression for the variables.",
"description": "The command regress fits a model of dependent variable on the independent variables using linear regression.", "description": "The command regress fits a model of dependent variable on the independent variables using linear regression. Factor variable is supported.",
"syntax": "regress depvar indepvarlist [, options]", "syntax": "regress depvar indepvarlist [, options]",
"examples": [ "examples": [
{ {
...@@ -197,8 +199,12 @@ function CommandExecutor() { ...@@ -197,8 +199,12 @@ function CommandExecutor() {
"description": "Displays linear regression model for income2004 based on income2003 with default confidence interval level set at 95%." "description": "Displays linear regression model for income2004 based on income2003 with default confidence interval level set at 95%."
}, },
{ {
"example": "ci income2004 income2003 , level(90)", "example": "regress income2004 income2003 , level(90)",
"description": "Displays linear regression model for income2004 based on income2003 with confidence interval level set at 90%." "description": "Displays linear regression model for income2004 based on income2003 with confidence interval level set at 90%."
},
{
"example": "regress income2002 income2004#income2003 ",
"description": "Displays linear regression model for the levels of income2003 interacted with the levels of income2004 based on income2002 with confidence interval level set at 95%."
} }
], ],
"options" : [ "options" : [
......
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