topic Re: Initialize a retain variable in SAS Programming

Initialize a retain variable

Mike018 — Wed, 10 Aug 2011 18:56:38 GMT

I have to initialize a variable in some precise situations but not at every loop of a data . So, I have used a retain statement on this variable. I initialize it to 0 (only in the case when I need to), but it didn't work.

Is anybody knows is it possible to initialize a variable when using a retain statement on it?

Initialize a retain variable

Reeza — Wed, 10 Aug 2011 19:27:29 GMT

Yes its possible.

If you show provide an example of you code, someone can probably show you where you're going wrong.

Initialize a retain variable

art297 — Wed, 10 Aug 2011 19:43:20 GMT

I agree with Fareeza that you have probably just overlooked something in your code and, to get anyone to give you feedback, you'll have to post your code.

But, as you can see from the following example, one can definitely do what you are trying to do:

proc sort data=sashelp.class out=retain_example;

by sex;

run;

data retain_example;

set retain_example;

by sex;

retain gender;

if _n_ eq 1 then gender="Female";

else if first.sex then gender="Male";

run;

Re: Initialize a retain variable

ChrisNZ — Wed, 10 Aug 2011 23:40:14 GMT

2 things you might not know:

- A retain statement is not executable, so it makes no difference if you put it after a test: it will always be used.

- A retain initialisation is only done at the first data step iteration, when _N_=1.

Re: Initialize a retain variable

art297 — Wed, 10 Aug 2011 23:49:31 GMT

Chris,

Yes, retain will work in either case, but its location definitely does affect the result. Run the following code and take a look at the order of the resulting variables in each case:

proc sort data=sashelp.class out=retain_example;

by sex;

run;

data retain_example1;

set retain_example;

by sex;

retain gender;

if _n_ eq 1 then gender="Female";

else if first.sex then gender="Male";

run;

data retain_example2;

retain gender;

set retain_example;

by sex;

if _n_ eq 1 then gender="Female";

else if first.sex then gender="Male";

run;

Re: Initialize a retain variable

ChrisNZ — Thu, 11 Aug 2011 02:36:15 GMT

Indeed, retain will only affect the variables already defined/known when the statement is encountered as the data step is compiled.

The point I was trying to make, since the OP wants to use retain and initialise values only when needed, is that

if TEST then do;

retain A 0;

...

end;

is the same as

retain A 0;

if TEST then do;

...

end;

Re: Initialize a retain variable

Mike018 — Thu, 11 Aug 2011 13:31:31 GMT

Thanks for your replies everybody, I'll prepare a simplified version of my program and I'll post it so maybe that will be able to find where I went wrong.

Re: Initialize a retain variable

mojerry2 — Thu, 11 Aug 2011 14:53:37 GMT

data test;

set original;

retain gender;

format gender $6.;/* used if new column*/

gender="male";

if var1='F' then gender="female";

run;

in this example gender is always "male" but with condition of var1='F' gender is "female"

Re: Initialize a retain variable

art297 — Thu, 11 Aug 2011 15:07:50 GMT

You aren't initializing gender in your retain statement and then overriding the value anyhow. Given the following sample dataset, what result to you want for gender for each record?

data original;

input var1 $;

cards;

;

run;

Re: Initialize a retain variable

Mike018 — Thu, 11 Aug 2011 15:14:36 GMT

This is a very light version of my program. I remove a lot of stuff that is useless to the comprehension of the problem.

The program have to generates a report of cashing for every bank.
In the infile, there are 2 types of record
G : The positive amounts of money
H : The negative amounts of money

So, I have to sort these records by type, bank_id, reference_id. I need to make a total for every bank. The totals of the types are already calculated and I recuperate theirs values via macro variables. At first, I print and make totals for the G records. After, I made totals for the H records. Also, I give you some explications about the variable cause theirs names are in french and maybe you're not going to understand

TOTAL_ENCAISSEMENTS_CAISSE, TOTAL_FRAIS_ENCAISSEMENTS_CAISSE

: Variables I use to conserve the bank totals
MONTANT_REEL, FRAIS_REEL : Variables that contain the monetary data of the current record
NO_REF : That's the reference_id
NO_CAISSE2 : That's the formatted bank_id

DATA AA;
FILE RAPPORT;
FORMAT TOTAL_ENCAISSEMENTS_CAISSE                COMMA19.2;
FORMAT TOTAL_FRAIS_ENCAISSEMENTS_CAISSE COMMA14.2;
FORMAT SOMME_ENC_FORMAT                                     COMMA19.2;
FORMAT SOMME_CORRECTIONS_FORMAT                COMMA19.2;
FORMAT SOMME_FRAIS_FORMAT                                  COMMA14.2;
RETAIN NO_REF NO_CAISSE2 TOTAL_ENCAISSEMENTS_CAISSE, TOTAL_FRAIS_ENCAISSEMENTS_CAISSE, SOMME_ENC_FORMAT;
SET DESJARD END=EOF;
BY TYPE NO_CAISSE NO_REF;
IF _N_ = 1 THEN
DO;                                                                                                                                              TOTAL_ENCAISSEMENTS_CAISSE =0;
    // Print the report column header
END;
SELECT (TYPE);
     WHEN ('G', 'H')
     DO;
          // Print the current record
           FRAIS_ENC_TEMP =
                       SUM(TOTAL_ENCAISSEMENTS_CAISSE,MONTANT_REEL);
           TOTAL_FRAIS_ENCAISSEMENTS_CAISSE = SUM    (TOTAL_FRAIS_ENCAISSEMENTS_CAISSE, FRAIS_REEL);

   IF LAST.NO_CAISSE THEN
     DO;
    // It's the last record of this bank, so I print totals and I want to initialize the
   variables for the next bank.
       PUT @045 FRAIS_ENC_TEMP                   COMMA19.2
               @064 TOTAL_FRAIS_ENCAISSEMENTS_CAISSE COMMA15.2;
       TOTAL_ENCAISSEMENTS_CAISSE = 0;
       TOTAL_FRAIS_ENCAISSEMENTS_CAISSE = 0;
       FRAIS_REEL = 0;
     END;
     IF LAST.TYPE THEN
       DO;
       IF (TYPE='G') THEN
         DO;
   // Positive numbers
         SOMME_ENC_FORMAT = INPUT("&SOMME_ENCAISSEMENTS.",COMMA19.2);
         PUT @045 SOMME_ENC_FORMAT           COMMA19.2
             @064 "&SOMME_FRAIS_ENCAISSEMENT.";
         END;
     ELSE IF (TYPE='H') THEN
       DO;
   // Negative numbers
         SOMME_CORRECTIONS_FORMAT =
                         INPUT("&SOMME_CORRECTIONS.",19.2) * -1;
         SOMME_FRAIS_FORMAT =
                         INPUT("&SOMME_FRAIS_CORRECTION.",12.2) * -1;
         PUT @046 SOMME_CORRECTIONS_FORMAT COMMA19.2
                  @064 SOMME_FRAIS_FORMAT COMMA15.2;
         END;
     END;
   ELSE
     DO;
       TOTAL_ENCAISSEMENTS_CAISSE =
                      SUM(TOTAL_ENCAISSEMENTS_CAISSE,MONTANT_REEL);
       TOTAL_FRAIS_ENCAISSEMENTS_CAISSE =
                      SUM(TOTAL_FRAIS_ENCAISSEMENTS_CAISSE,FRAIS_REEL);
    END;
END;
OTHERWISE;
END;

Re: Initialize a retain variable

Mike018 — Thu, 11 Aug 2011 15:33:19 GMT

Here is an example of the output of the program

39,872,103.06

654,321.08

5,036,428.90

----------

45,562,853.04 (This first total is ok)

30,000,003.85

----------

35,036,432.75 (The total is supposed to be 30,000,003.85 instead the program has calculated

5,036,428.90 (the previous) + 30,000,003.85)

8.07

412.84

----------

30,000,424.76 (The total is supposed to be 420.91 instead the program has calculated

30,000,003.85 (the previous) + 8.07 + 412.84)

Thanks is advance

Re: Initialize a retain variable

art297 — Thu, 11 Aug 2011 16:17:49 GMT

I don't have time to review your full code, and without a sample dataset (with intended resulting values) can't test the code, but I did notice some things that were questionable:

1. In your retain statement you separate some of the variables with commas rather than spaces. I would think that would result in a fatal error with the datastep never even running.

2. It appears that you are retaining more variables than you really want/need to retain

3. You appear to output records at a point when you probably first want to include the data in the calculations, thus each time you get a bank's last record (within a type) you output the record, initialize some values, and then continue with the calculations.

4. Is there a reason why you are trying to calculate each type separately? Since you have sorted bank within type, each banks values for a given type will be calculated, followed by the next type.

5. Should some of the other retained values be initialized at the point where you initialize two of them?

Re: Initialize a retain variable

ChrisNZ — Thu, 11 Aug 2011 22:03:35 GMT

My advice would be for you to create a small (say 5- or 20- record) dummy dataset, write a small data step that does sums exactly what you want and apply the knowledge to your larger problem.

If you can't solve the issue, submit this small dataset and data step here.

As it is, you haven't reduced the problem enough in your sample code for us to help, especially since we can't see the data going in and what you want going out.

Re: Initialize a retain variable

DBailey — Fri, 12 Aug 2011 14:11:56 GMT

Couple of questions:

Why are you retaining the variables NO_REF NO_CAISSE? Should the by variable allow you to do what you need?

You can also set the initial value of a retain variable directly without using the _N_ variable as in:

RETAIN

TOTAL_ENCAISSEMENTS_CAISSE 0

TOTAL_FRAIS_ENCAISSEMENTS_CAISSE 0

SOMME_ENC_FORMAT 0;

I'm having some difficulty following as I'm not conversant in French....but...It looks to me that the by variables might be out of order. Shouldn't the logic by caisse then type then refno?

Your code seems to reset the variables if it is the last caisse. But it might be the last caisse and not the last type. If that is the case, then your code goes on to re-add montant_reel to total_encaissements.

Sorry if that's no help...but its all I could see that might be an issue.

Re: Initialize a retain variable

Mike018 — Fri, 12 Aug 2011 16:34:32 GMT

@ art297

1. It's an error when I simplify the code - in my program, space is the only separator between the retain variables

2. Ya, there were 3 variables that I retain unnecessarily.

@ Chris@NewZealand I'll try it

@ DBailey

1. I didn't need to retain these 2 variables. I remove the retain statement on them.

2. They want that I print totals of the G type records and after print totals of the H type records. So, a bank may have totals in the first section and others in the second section.

Thanks, I'll try with a smaller dataset and I'll keep you informed!

Re: Initialize a retain variable

Mike018 — Mon, 15 Aug 2011 19:07:53 GMT

I've created a small dataset and I've found where was the problem. I have to increment a variable before I test the LAST.BANK_ID condition. I have put the wrong code in comment.

DATA EXAMPLE;
   INPUT TYPE REF_ID BANK_ID NUMBER;
DATALINES;
1 1 1 1003.32
0 2 2    3.89
0 4 2   45.23
1 3 9 5623.02
0 7 6 563.56
1 5 9 714.32
0 9 2 145.32
;

PROC SORT DATA=EXAMPLE;
BY TYPE BANK_ID REF_ID;
RUN;

DATA OUT;
FORMAT SUM    COMMA15.2;
FORMAT TEMP   COMMA15.2;
FORMAT TYPE_0 1.;
FORMAT TYPE_1 1.;
SET EXAMPLE END=EOF;
BY TYPE BANK_ID REF_ID;
RETAIN SUM 0 TYPE_0 0 TYPE_1 1 TEMP 0 TYPE_0 0 TYPE_1 0;
SUM = 0;
SELECT (TYPE);
   WHEN (0,1)
   DO;
   TEMP = TEMP + NUMBER;
IF LAST.BANK_ID THEN
DO;
SUM = TEMP;
TEMP = 0;
IF LAST.TYPE THEN
   DO;
   IF TYPE = 0 THEN
    DO;
    TYPE_0 = SUM(TYPE_0,1);
    END;
     ELSE IF TYPE = 1 THEN
      DO;
    TYPE_1 = SUM(TYPE_1,1);
    END;
   END;
END;
/*ELSE
DO;
TEMP = TEMP + NUMBER;
END;*/
   END;
OTHERWISE;
END;

PROC PRINT DATA=OUT;
RUN;

Re: Initialize a retain variable

art297 — Mon, 15 Aug 2011 19:10:59 GMT

Are you asking the forum to look at it or are you just letting us know that you now have your desired result?

Re: Initialize a retain variable

Mike018 — Mon, 15 Aug 2011 19:12:42 GMT

It works