2.13.1.15 pcorrcoef (Pro)

Contents

Menu Information

Partial Correlation Coefficient

Brief Information

Compute partial correlation coefficients using control variables

Additional Information

Minimum Origin Version Required: Origin 2016 SR0

This feature is for OriginPro only.

Command Line Usage

pcorrcoef irng:= (wcol(3):wcol(5)) control:=wcol(6) flag:=1;

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
Variables irng

Input

Range

<active>
 Specify the input data for variables of interest. Note that beginning with Origin 2020b, there is a shortened syntax that follows the form [Book]Sheet!(N1:N2), N1 = the beginning column index and N2 being the ending column index in a contiguous range of columns. More complex strings from non-contiguous data of the form [Book]Sheet!([Book]Sheet!N1:N2,[Book]Sheet!N3:N4) are also possible.
Controlling Variables control

Input

Range

<unassigned>
 Specify the data for control variables, the effect of control variable will be excluded when measure the relationship of above variables.
Exclude Missing Values missing

Input

int

0
 Specify the way to exclude the missing values.

Option list:

  • pairwise:Pairwise
    Exclude missing values in pair-wise fashion. When computing correlation between two columns, the corresponding two entries will be excluded if there is any missing value.
  • listwise:Listwise
    Exclude missing values in list-wise fashion. Exclude the entire row for all datasets if there are any missing values.
Test of Significance tail

Input

int

1
 This variable indicates whether an one-, or two- tailed test should be performed.

Option list:

  • one:One-tailed
    This variable indicates the one-tailed test is performed.
  • two:Two-tailed
    This variable indicates the two-tailed test is performed.
Show Significance in Result Table sig

Input

int

0
 Specify whether to display Significance in Result Table in the report worksheet.
Flag Significant Correlations flag

Input

int

0
 Specify whether to mark the Partial Correlation Coefficient value significant at the 0.05 level with asterisk in Result Table, and highlight the Partial Correlation Coefficient value significant at the 0.05 level with red color in the flat sheet
Result Table rt

Output

ReportTree

[<input>]<new>
Specify target worksheet for output of report worksheet.
Correlations Sheet corr

Output

ReportData

[<input>]<new>
 Specify target worksheet for output of Partial Correlation Coefficients.

More Information

For more information, please refer to our User Guide.

Related X-Functions

corrcoef

Keywords:significance, pairwise, listwise