2.13.1.14 mstats(Pro)
Brief Information
Compute descriptive statistics on matrix data
Additional Information
This feature is for OriginPro only.
Command Line Usage
1. mstats im:=MBook1;
2. mstats im:=MBook1 mean:=mymean sd:=mysd sum:=mysum;
X-Function Execution Options
Please refer to the page for additional option switches when accessing the x-function from script
Variables
Display
Name
|
Variable
Name
|
I/O
and
Type
|
Default
Value
|
Description
|
| Input Matrix
|
im
|
Input
MatrixObject
|
<active>
|
This variable specifies the range of input data for which descriptive statistics will be calculated.
|
| Mean
|
mean
|
Output
double
|
<unassigned>
|
The mean of a collection of numbers is their arithmetic average. This variable specifies the name of output mean value.
|
| Standard Deviation
|
sd
|
Output
double
|
<unassigned>
|
Standard deviation is a statistical measure indicating how grouped a dataset is around its average value. This variable specifies the name of the output standard deviation value.
|
| Number of Observations
|
n
|
Output
int
|
<unassigned>
|
This variable specifies the name or label for the sample size.
|
| Minimum
|
min
|
Output
double
|
<unassigned>
|
This variable specifies a label for the minimum value of the data set.
|
| Maximum
|
max
|
Output
double
|
<unassigned>
|
This command specifies the name of output maximum value.
|
| Sum
|
sum
|
Output
double
|
<unassigned>
|
This command specifies a name for the output sum value.
|
| Number of Missing Values
|
missing
|
Output
int
|
<unassigned>
|
This command outputs the number of missing data points in the data set.
|
Description
Descriptive statistics are used to describe the basic aspects of dataset, including its average and standard deviation. These statistics summarize sample data with standard measures so that general properties of the data are known, and the data set can be compared to other sets of similar data.
The X-function of mstats is used to calculate the descriptive statistics for Matrix object. It can gives the mean, standard deviation, number of observations, minimum, maximum, sum and number of missing values of the specified Matrix.
Examples
1. To return descriptive statistics for an active Matrix object, type into the Command Window:
mstats
Otherwise, specify the Matrix on which to perform analysis in the script by typing, for example:
mstats im:=MBook1;
2. You can also define labels for the variables and use them in later operations, for example:
mstats im:=MBook1 mean:=m sd:=std sum:=mysum
Algorithm
Let  for  denote the input values. Then the computation equations can be expressed as follows:
1. Mean:
2. Standard deviation:
3. Number of Observations is the total number of valid data.
4. Minimum is the minimum value of the specified data.
5. Maximum is the maximum value of the specified data.
6. Sum:
7. Number of Missing Values specifies how many values of the data are missing.
References
1. Silverman, B.W. (1986), Density Estimation for Statistics and Data Analysis, New York: Chapman and Hall.
2. Tukey, J.W. (1977), Exploratory Data Analysis, Reading, MA: Addison-Wesley.
3. Erickson B H and Nosanchuk T A (1985) Understanding Data. Open University Press.
Related X-Functions
moments, quantiles, rowstats, rowquantiles
Keywords:mean, median, standard deviation, sum
|