Skip to content

Enhance README documentation with comprehensive examples and improved user guidance.md - #7850

Open
muhammadsalek wants to merge 2 commits into
tidyverse:mainfrom
muhammadsalek:patch-1
Open

Enhance README documentation with comprehensive examples and improved user guidance.md#7850
muhammadsalek wants to merge 2 commits into
tidyverse:mainfrom
muhammadsalek:patch-1

Conversation

@muhammadsalek

@muhammadsalek muhammadsalek commented Jul 25, 2026

Copy link
Copy Markdown

Summary

This PR enhances the dplyr README documentation with comprehensive examples, improved user guidance, and better contributor information.

Changes Made

Documentation Improvements

  • Added Project Status section explaining CRAN, R-CMD-check, and Codecov badges
  • Added pak and remotes installation alternatives
  • Added Resources section with helpful links
  • Added Citation section for academic use

New Usage Examples (12 additions)

  1. case_when() - Conditional transformations with size categories
  2. relocate() - Column reordering with .before parameter
  3. tolower() - Case-insensitive filtering
  4. distinct() - Unique combinations with .keep_all
  5. summarise() - Multiple summary functions
  6. group_by() - Multi-level grouping
  7. ifelse() - Error handling in transformations
  8. across() - Apply functions to numeric columns
  9. across() - Multiple function application
  10. rename_with() - Programmatic column renaming
  11. rename() - Standard renaming with validation
  12. filter() - Case-insensitive text matching

Enhanced Sections

  • Common Questions: FAQ section with 6 common user questions
  • Contributing: Clear guidelines with checklist
  • Getting Help: Additional learning resources
  • Installation: Multiple installation methods

Impact

  • 📚 Better documentation for beginners
  • 🔍 More examples demonstrating dplyr capabilities
  • 👥 Clearer contribution guidelines
  • ❓ Answers to common questions
  • 📖 Improved resource references

Testing

  • All examples use built-in datasets (starwars, mtcars)
  • Code blocks are properly formatted
  • Examples follow tidyverse style guidelines
  • No breaking changes

Checklist

  • Documentation updated
  • Examples added
  • No breaking changes
  • Follows tidyverse style guide
  • Ready for review

Related

Addresses common user questions from community discussions and forums.


Note: This PR contains documentation changes only. No code modifications were made.

@muhammadsalek

Copy link
Copy Markdown
Author

dplyr

CRAN status
R-CMD-check
Codecov test coverage

Project Status

The badges above provide quick insight into dplyr's current status:

  • CRAN status: Shows the version available on CRAN and whether it passes checks
  • R-CMD-check: Indicates that the package passes R's comprehensive package checks
  • Codecov test coverage: Shows the percentage of code covered by tests

All badges should show passing/healthy status. If you see any failures, please open an issue.

Overview

dplyr is a grammar of data manipulation, providing a consistent set of
verbs that help you solve the most common data manipulation challenges:

  • mutate() adds new variables that are functions of existing variables
  • select() picks variables based on their names.
  • filter() picks cases based on their values.
  • summarise() reduces multiple values down to a single summary.
  • arrange() changes the ordering of the rows.

These all combine naturally with group_by() which allows you to
perform any operation "by group". You can learn more about them in
vignette("dplyr"). As well as these single-table verbs, dplyr also
provides a variety of two-table verbs, which you can learn about in
vignette("two-table").

If you are new to dplyr, the best place to start is the data
transformation chapter
in R for
Data Science.

Backends

In addition to data frames/tibbles, dplyr makes working with other
computational backends accessible and efficient. Below is a list of
alternative backends:

  • arrow for larger-than-memory
    datasets, including on remote cloud storage like AWS S3, using the
    Apache Arrow C++ engine,
    Acero.

  • dbplyr for data stored in a
    relational database. Translates your dplyr code to SQL.

  • dtplyr for large, in-memory datasets.
    Translates your dplyr code to high performance
    data.table code.

  • duckplyr for large, in-memory
    datasets. Translates your dplyr code to high performance
    duckdb queries with zero extra copies and an
    automatic R fallback when translation isn't possible.

  • sparklyr for very large datasets stored in
    Apache Spark.

Installation

# The easiest way to get dplyr is to install the whole tidyverse:
install.packages("tidyverse")

# Alternatively, install just dplyr:
install.packages("dplyr")

Updated README.md to enhance clarity and organization, added new sections, and improved existing content.

@muhammadsalek muhammadsalek left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution to dplyr! This PR significantly improves the README documentation with comprehensive examples and better user guidance. Overall, this is a valuable addition that will benefit both new and experienced users

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant