Add lateral_return_yards variable?

[TheMathNinja]

1. **Have you installed the latest development version of the package(s) in question? **
   Yes

2. Describe the bug
   return_yards is returning the wrong number in the pbp df.

3. Reprex

slay_bug <- nflfastR::load_pbp(2021) %>%
  filter(week == 6,
         interception == 1,
         defteam == "PHI")

4. Expected Behaviour
   return_yards should be 6. Anthony Harris should get 2, then he laterals to Darius Slay who gets 4 more. But return_yards shows 4, only counting the yards post-lateral.

5. nflverse_sitrep()

sitrep

# nflverse_sitrep() goes here

6. Screenshots

7. Additional context

[mrcaseb]

This is actually not a bug in return yards as it is exactly the same like for rushing or receiving yards when laterals happen in a play. We could catch this for plays with one lateral (!) by adding a lateral_return_yards variable for stat IDs 27 and 28

Here

nflfastR/R/helper_tidy_play_stats.R

Line 189 in 0fa754d

row$return_yards <- play_stats$yards[index]

and here

nflfastR/R/helper_tidy_play_stats.R

Line 201 in 0fa754d

row$return_yards <- play_stats$yards[index]

Analog to stat IDs 23 and 24 for example

nflfastR/R/helper_tidy_play_stats.R

Line 149 in 0fa754d

row$lateral_receiving_yards <- play_stats$yards[index]

nflfastR/R/helper_tidy_play_stats.R

Line 163 in 0fa754d

row$lateral_receiving_yards <- play_stats$yards[index]

As soon as multiple laterals with non 0 yards happen in a play there is no chance to see them in either of these variables. That would be very inefficient in a tidy data structure.

[mrcaseb]

For calculate_player_stats() we catch this by loading yards from a separate file that is hosting plays with multiple laterals, which are very rare but happen.

[mrcaseb]

We will not add a new variable to pbp but the new function calculate_stats() will have full return yards information