Commit bf6b8cf1 authored by Archana Bidargaddi's avatar Archana Bidargaddi
Browse files

#3897 , documentation for pwcorr added.

parent f3096f78
......@@ -31,7 +31,7 @@ function CommandExecutor() {
"parameters": "varlist [if] [, options]",
"shortDescription": "Generates a correlation matrix.",
"description": "The correlate command displays the correlation matrix for a group of variables. The varlist is mandatory. ",
"syntax": "correlate varlist [if]",
"syntax": "correlate varlist [if] [, options]",
"examples": [
{
"example": "correlate gender age income",
......@@ -126,6 +126,39 @@ 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": {
"parameters": "varlist (rule) [(rule) ...] [, generate(newvar)]",
"shortDescription": "Recode categorical variables. CURRENTLY NOT SUPPORTED",
......
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