PRTools Contents

PRTools User Guide

setuser

SETUSER

Set the user field of a dataset

    A = SETUSER(A,S,FIELD)

Input
 A Dataset
 S Variable to be stored in the user field
 FIELD Desired field, default 'USER'.

Output
 A Updated dataset

Description

Set or reset the subfield FIELD of the user field of A by S.  If FIELD is '' the entire userfield is replaced by S.

Note the the USER field of datasets was originally intended for a user  defined description of datasets. Later its usage was extended to a field  for storing general information on datasets. For that reason 'old'  datasets without a structure in the user field are transformed such that  this information is stored in a subfield USER in the user field. It can  be retrieved by GETUSER(A,'USER').

Note also that for reasons of backward compatibility the parameter order  of the SETUSER command differs from similar Matlab commands like  SETFIELD: first field content, then field name.

PRTools Contents

PRTools User Guide

This file has been automatically generated. If badly readable, use the help-command in Matlab.