Parameterized reports in R Programming - Step-by-Step Execution

Concept Flow - Parameterized reports

Start Report

↓

Receive Parameters

↓

Use Parameters in Data Query

↓

Generate Report Content

↓

Render Report with Parameters

↓

Output Final Report

↓

End

The report starts by receiving parameters, uses them to filter or customize data, then generates and renders the report accordingly.

Execution Sample

R Programming

library(rmarkdown)
params <- list(year = 2023)
rmarkdown::render("report.Rmd", params = params)

This code runs an R Markdown report with a parameter 'year' set to 2023.

Execution Table

Step	Action	Parameter State	Data Query	Report Output
1	Start report rendering	year = 2023	No query yet	No output yet
2	Pass parameter to report	year = 2023	Prepare query filtering year = 2023	No output yet
3	Execute data query	year = 2023	Data filtered for year 2023	No output yet
4	Generate report content	year = 2023	Data ready	Report sections created with 2023 data
5	Render report	year = 2023	Data used	Report rendered with 2023 data
6	Output report	year = 2023	Data used	Final report file created
7	End	year = 2023	Data used	Report complete

💡 Report rendering ends after outputting the final report file.

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 5	Final
params$year	undefined	2023	2023	2023	2023
data_query	none	prepared with year=2023	filtered data for 2023	filtered data for 2023	filtered data for 2023
report_output	none	none	none	rendered report with 2023 data	final report file

Key Moments - 3 Insights

Why do we need to pass parameters before running the report?

Parameters tell the report what data or options to use; without them, the report can't filter or customize content (see execution_table step 2).

Does the data query run before or after parameters are set?

The data query runs after parameters are set, so it can use them to filter data correctly (see execution_table step 3).

Is the report output created before or after data is filtered?

The report output is created only after data is filtered and content is generated (see execution_table steps 4 and 5).

Visual Quiz - 3 Questions

Look at the execution table, what is the value of 'params$year' at step 3?

A 2023

B undefined

C NULL

D 2022

💡 Hint

Check the 'Parameter State' column at step 3 in the execution_table.

At which step does the report start rendering with the filtered data?

A Step 2

B Step 4

C Step 5

D Step 3

💡 Hint

Look for 'Render report' action in the execution_table.

If the parameter 'year' was changed to 2022, which variable in variable_tracker would change?

A params$year only

B params$year and data_query

C data_query only

D report_output only

💡 Hint

Changing the parameter affects both the parameter value and the data filtered (see variable_tracker).

Concept Snapshot

Parameterized reports in R allow passing values to customize report content.
Use rmarkdown::render() with a params list.
Parameters filter data or control report sections.
Report runs steps: receive params, query data, generate content, render output.
This makes reports flexible and reusable.

Full Transcript

This visual execution shows how parameterized reports work in R. The report starts by receiving parameters, like 'year = 2023'. These parameters are used to prepare and filter the data query. After filtering, the report content is generated using the filtered data. Then the report is rendered and output as a final file. Variables like 'params$year' hold the parameter value throughout. The data query changes after parameters are set to filter correctly. The report output is created only after data is ready. This step-by-step flow helps beginners see how parameters control report generation.

Practice

1. What is the main purpose of using parameterized reports in R Markdown?

easy

A. To speed up the knitting process

B. To customize report content without changing the code

C. To automatically generate plots

D. To create interactive dashboards

Solution

1. Step 1: Understand parameterized reports concept

   Parameterized reports allow passing different inputs to the same report code.

2. Step 2: Identify the main benefit

   This lets you customize the report output without editing the code itself.

3. Final Answer:

   To customize report content without changing the code -> Option B

4. Quick Check:

   Parameterized reports = customize content without code change [OK]

Hint: Think: change inputs, not code, to customize reports [OK]

Common Mistakes:

• Confusing parameterized reports with speeding up knitting
• Thinking it automatically creates plots
• Mixing with dashboard creation

2. Which YAML header syntax correctly defines a parameter named year with default value 2023?

easy

A. params:
year: "2023"

B. parameters:
year = 2023

C. parameters:
year: 2023

D. params:
year: 2023

Solution

1. Step 1: Recall YAML parameter syntax in R Markdown

   Parameters are defined under params: with key-value pairs.

2. Step 2: Check correct key and value format

   params: year: 2023 uses params: and year: 2023 correctly without quotes needed for numbers.

3. Final Answer:

   params: year: 2023 -> Option D

4. Quick Check:

   YAML params use 'params:' and colon syntax [OK]

Hint: Use 'params:' and colon, no equals sign in YAML [OK]

Common Mistakes:

• Using 'parameters:' instead of 'params:'
• Using equals sign '=' instead of colon ':'
• Putting numbers in quotes unnecessarily

3. Given this R Markdown snippet, what will be the output when params$region is set to "West"?

```{r}
if (params$region == "West") {
  print("Sales are high in the West")
} else {
  print("Sales data not available")
}
```

medium

A. [1] "Sales are high in the West"

B. [1] "Sales data not available"

C. Error: object 'params' not found

D. [1] "Sales are high in the East"

Solution

1. Step 1: Check the condition with given parameter

   The condition checks if params$region equals "West". It is set to "West".

2. Step 2: Determine which print statement runs

   Since condition is true, it prints "Sales are high in the West".

3. Final Answer:

   [1] "Sales are high in the West" -> Option A

4. Quick Check:

   params$region == "West" -> print message for West [OK]

Hint: Match param value exactly to choose output branch [OK]

Common Mistakes:

• Confusing the else branch output
• Assuming params is undefined causing error
• Mixing region names in output

4. Identify the error in this R Markdown YAML header for parameterized report:

---
title: "Sales Report"
params:
  month = "January"
output: html_document
---

medium

A. Incorrect output format specified

B. Missing quotes around 'January'

C. Using '=' instead of ':' to assign parameter value

D. Missing 'params' section

Solution

1. Step 1: Review YAML parameter syntax

   Parameters use colon ':' to assign values, not equals '='.

2. Step 2: Identify the syntax error

   Here, month = "January" uses '=' which is invalid YAML syntax.

3. Final Answer:

   Using '=' instead of ':' to assign parameter value -> Option C

4. Quick Check:

   YAML params need ':' not '=' [OK]

Hint: YAML uses colon ':' for key-value pairs, never '=' [OK]

Common Mistakes:

• Using '=' instead of ':' in YAML
• Thinking quotes are mandatory for strings
• Confusing output format with params syntax

5. You want to create a parameterized report that filters a dataset by category and year. Which approach correctly uses parameters in the R code chunk to filter df?

hard

A. filtered_df <- subset(df, category == params$category & year == params$year)

B. filtered_df <- df[df$category = params$category & df$year = params$year, ]

C. filtered_df <- filter(df, category = params$category, year = params$year)

D. filtered_df <- df[category == params$category & year == params$year]

Solution

1. Step 1: Understand filtering syntax in R

   The subset() function uses logical conditions with '==' to filter rows.

2. Step 2: Check parameter usage in filtering

   filtered_df <- subset(df, category == params$category & year == params$year) correctly uses params$category and params$year with '==' inside subset().

3. Final Answer:

   filtered_df <- subset(df, category == params$category & year == params$year) -> Option A

4. Quick Check:

   Use '==' for comparison and subset() for filtering [OK]

Hint: Use subset() with '==' and params$ for filtering [OK]

Common Mistakes:

• Using '=' instead of '==' for comparison
• Incorrect subsetting syntax without dataframe reference
• Confusing filter() syntax without library