Copydsfields: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Jeremy
(Importing text file)
Line 1: Line 1:
===Purpose===
===Purpose===
Copies informational fields between datasets and/or model structures.
Copies informational fields between datasets and/or model structures.
===Synopsis===
===Synopsis===
:to = copydsfields(from,to,''modes'',''block'')
:to = copydsfields(from,to,''modes'',''block'')
===Description===
===Description===
Copies all informational fields from one dataset to another, one model structure to another, or between datasets and models. This function copies the fields: label, class, classlookup, title, axisscale, and includ as well as the "<field>name" assosciated with each (e.g. classname). If copying to or from a model structure, the fields to be copied from/to are sub-fields of the detail field.
Copies all informational fields from one dataset to another, one model structure to another, or between datasets and models. This function copies the fields: label, class, classlookup, title, axisscale, and includ as well as the "<field>name" assosciated with each (e.g. classname). If copying to or from a model structure, the fields to be copied from/to are sub-fields of the detail field.
====INPUTS====
====INPUTS====
* '''from''' = dataset or model from which fields should be copied, and
* '''from''' = dataset or model from which fields should be copied, and
* '''to''' = dataset or model to which fields should be copied.
* '''to''' = dataset or model to which fields should be copied.
====OPTIONAL INPUTS====
====OPTIONAL INPUTS====
* '''modes''' = modes (dims) which should be copied {default: all modes}. (modes) can be a cell of {[from_modes] [to_modes]} to allow cross-mode copying.
* '''modes''' = modes (dims) which should be copied {default: all modes}. (modes) can be a cell of {[from_modes] [to_modes]} to allow cross-mode copying.
* '''block''' =  data block of model from/to which information should be copied.
* '''block''' =  data block of model from/to which information should be copied.
*  '''Default''': block 1. Can also be a cell of {[from_modes] [to_block]} to allow cross-block copying. This setting has noeffect with two DataSet objects.Output is: to, the updated dataset or model.
*  '''Default''': block 1. Can also be a cell of {[from_modes] [to_block]} to allow cross-block copying. This setting has noeffect with two DataSet objects.Output is: to, the updated dataset or model.
====OUTPUTS====
====OUTPUTS====
* '''to'''  =  the updated dataset or model.
* '''to'''  =  the updated dataset or model.
===Examples===
===Examples===
  mydataset2 = copydsfields(mydataset1, mydataset2);
  mydataset2 = copydsfields(mydataset1, mydataset2);
copies all fields for all modes of mydataset1 into mydataset2 (copies set 1 only).
copies all fields for all modes of mydataset1 into mydataset2 (copies set 1 only).
  mydataset2 = copydsfields(modl, mydataset2, {2 1});
  mydataset2 = copydsfields(modl, mydataset2, {2 1});
copies all fields from mode 2 (variables) of modl into mode 1 of mydataset2.
copies all fields from mode 2 (variables) of modl into mode 1 of mydataset2.
  modl = copydsfields(mydataset,modl,1,{1 2});
  modl = copydsfields(mydataset,modl,1,{1 2});
copies all fields for mode 1 (samples) from set 1 of  mydataset into block 2 (e.g. y-block) of modl.
copies all fields for mode 1 (samples) from set 1 of  mydataset into block 2 (e.g. y-block) of modl.
===See Also===
===See Also===
[[dataset/dataset]], [[modelstruct]], [[pca]], [[pcr]], [[pls]]
[[dataset/dataset]], [[modelstruct]], [[pca]], [[pcr]], [[pls]]

Revision as of 14:24, 3 September 2008

Purpose

Copies informational fields between datasets and/or model structures.

Synopsis

to = copydsfields(from,to,modes,block)

Description

Copies all informational fields from one dataset to another, one model structure to another, or between datasets and models. This function copies the fields: label, class, classlookup, title, axisscale, and includ as well as the "<field>name" assosciated with each (e.g. classname). If copying to or from a model structure, the fields to be copied from/to are sub-fields of the detail field.

INPUTS

  • from = dataset or model from which fields should be copied, and
  • to = dataset or model to which fields should be copied.

OPTIONAL INPUTS

  • modes = modes (dims) which should be copied {default: all modes}. (modes) can be a cell of {[from_modes] [to_modes]} to allow cross-mode copying.
  • block = data block of model from/to which information should be copied.
  • Default: block 1. Can also be a cell of {[from_modes] [to_block]} to allow cross-block copying. This setting has noeffect with two DataSet objects.Output is: to, the updated dataset or model.

OUTPUTS

  • to = the updated dataset or model.

Examples

mydataset2 = copydsfields(mydataset1, mydataset2);

copies all fields for all modes of mydataset1 into mydataset2 (copies set 1 only).

mydataset2 = copydsfields(modl, mydataset2, {2 1});

copies all fields from mode 2 (variables) of modl into mode 1 of mydataset2.

modl = copydsfields(mydataset,modl,1,{1 2});

copies all fields for mode 1 (samples) from set 1 of mydataset into block 2 (e.g. y-block) of modl.

See Also

dataset/dataset, modelstruct, pca, pcr, pls