Consider using a service account token (or no token!) | When and how to use OOB | Request OOB auth in the PKG_auth() call | Set the "gargle_oob_default" option | Conventional vs. pseudo-OOB auth | How pseudo-OOB works | More details about the deprecation of conventional OOB | But I didn't need OOB yesterday! | Further reading

Provide a token or pre-authorize token discovery | Sidebar 1: Deployment | Sidebar 2: I just want my .Rmd to render | Embrace credentials available in certain cloud settings | Google Compute Engine | Workload Identity on Google Kubernetes Engine (GKE) | Workload identity federation (AWS, GitHub Actions) | Provide a service account token directly | Rig a service or external account for use with Application Default Credentials | Provide an OAuth token directly | Arrange for an OAuth user token to be re-discovered | I just want my .Rmd to render | Project-level OAuth cache | OAuth client type: where the token is obtained vs. where it's used

How roxygenize() works | Key data structures | Tags | Blocks | Adding a new .Rd tag | Using your new tag | Creating a new roclet | Custom tags | The roclet | Adding a roclet to your workflow | Conclusion: further extension ideas

token_fetch() | Get verbose output | credentials_byo_oauth2() | credentials_service_account() | credentials_external_account() | credentials_app_default() | credentials_gce() | credentials_user_oauth2() | Manipulate the credential function registry

Get a Google Cloud Platform project | Enable API(s) | Think about billing | API Key | What does a user do with an API key? | OAuth client ID and secret | What does a user do with an OAuth client? | Service account token | What does a user do with a service account token? | Workload identity federation | Further reading

Introduction | Instrumenting R Source Code | Modifying the call tree | Source References | Refining Source References | Replacing Source In Place | Object Orientation | S3 Classes | S4 Classes | Reference Classes | Compiled code | Gcov | Makevars | Subprocess | Output Formats | Codecov.io and Coveralls.io | Prior Art | Overview | R-coverage | Test Coverage | Covr | Conclusion

Why use gargle's request helpers? | High-level design pattern | gargle's HTTP request helpers | Discovery Documents | Method (or endpoint) data | Design suggestion: forming requests | Design suggestion: making requests | Reference

"gargle_verbosity" option | gargle_oauth_sitrep() | Why do good tokens go bad? | Too many tokens | Credential rolling | How to avoid auth pain | How to inspect the last response

TL;DR | Project root | A simple example | Relative paths to a stable root | Example A: From vignettes | Example B: From tests/testthat | Summary of Examples A and B | Criteria | Shortcuts | Fixed root | testthat files | Another example: custom testing utilities | Summary | Acknowledgement

Header | Tweak header | Restyle header | Footer | Restyle footer | Compute additional info beforehand | Row IDs | Body | Tweak pillar composition | Tweak display of compound pillars | Restyle body

Requirements | Overview | Initialization | Setup | Header, body, footer | Colonnade | Creating pillar objects | Pillar lists | Simple pillars | Components | Formatting pillars

Basic functionality | Declare the location of the current script | Use project-relative paths | Situation report | What if the working directory is wrong? | Extra safety | Conflicts with other packages | Specify a unique identifier | Beyond here | Change project root | Under the hood: rprojroot

rmarkdown starts in a subdirectory | here always uses project-relative paths

Introduction | The simple API | Errors from the simple API | The low level API | The dummy credential helper | Errors from the low level API | Testing

1. HTTP Client | ncurl: Basic Requests | ncurl_aio: Async Requests | Promises Integration | ncurl_session: Persistent Connections | 2. WebSocket Client | 3. Unified HTTP/WebSocket Server | Handler Types | HTTP Request Handlers | Static Content Handlers | WebSocket Handlers | HTTP Streaming Handlers | Server-Sent Events | 4. Secure Connections (TLS) | Public Internet HTTPS | Self-Signed Certificates | 5. Client Example: Shiny ExtendedTask | 6. Server Example: Quarto Site with Dynamic API | 7. Server Deployment with _server.yml

Basics | Functions | Deprecate a function | Gradual deprecation | Rename a function | Supersede a function | Mark function as experimental | Arguments | Deprecate an argument, keeping the existing default | Deprecating an argument, providing a new default | Renaming an argument | Reducing allowed inputs to an argument | Anything else

1. Introduction | mirai | mirai (advanced) | daemons | 2. Error Handling | 3. Local Daemons | With Dispatcher (default) | Without Dispatcher | everywhere() | 4. Memory Management | Queue Backpressure | Non-blocking Submission | Shared Memory with Local Daemons | 5. mirai_map | Basic Usage | Collection Options | Multiple Map | Nested Maps | 6. Remote Infrastructure | Remote Daemons Overview | Launching Remote Daemons | SSH Direct Connection | SSH Tunnelling | HPC Cluster Resource Managers | Job Arrays | HTTP Launcher | Default: Posit Workbench | Custom HTTP APIs | Troubleshooting | Generic Remote Configuration | Manual Deployment | TLS Secure Connections | Automatic Zero-configuration Default | CA Signed Certificates | 7. Compute Profiles | with_daemons() and local_daemons() | With Method | 8. Advanced Topics | Random Number Generation | Synchronous Mode

Writing to the System Log | Sending Logs over HTTP | Writing Directly to TCP Connections

Using cat() | The log4r Package | The futile.logger Package | The logging Package | The logger Package | The lgr Package | The rlog Package | Test All Loggers | Benchmarks | How long does it take to print messages? | How long does it take to decide to do nothing?

Generics | Supported syntax | Classes | Methods

1. Migration from future_promise() | 2. Setting the random seed | 3. Accessing package functions during development | 4. Why does mirai() take time when it's meant to return immediately? | 5. Creating daemons on-demand or shutting down idle daemons | 6. Launching daemons --vanilla

RStudio | Emacs | Installation | Configuration | Vim - syntastic | Vim - ALE | Sublime Text 3 | Atom | Visual Studio Code

Within a package | Across packages

1. Event-driven promises | 2. Shiny ExtendedTask: Introduction | 3. Shiny ExtendedTask: Cancellation | 4. Shiny ExtendedTask: Generative Art | 5. Shiny ExtendedTask: mirai map | 6. Shiny Async: Coin Flips | 7. Shiny Async: Progress Bar | 8. Plumber GET Endpoint | 9. Plumber POST Endpoint

1. Serialization: Arrow, polars and beyond | 2. Serialization: Torch | 3. Database Hosting using Arrow Database Connectivity | 4. Shiny / mirai / DBI / ADBC Integrated Example

Getting started | Theming | Light switch | Bootswatch themes | bslib variables | Fonts | Syntax highlighting | Math rendering | Navbar style | Layout | Navbar | Footer | Additional HTML and files | Template packages | Porting a template package | PR previews | Conclusion

Basics | Running roxygen | Basic process: human readable documentation | Basic process: making functions available to users | Learn more

1. Request Reply Protocol | 2. Publisher Subscriber Protocol | 3. Surveyor Respondent Protocol | 4. Device (Broker / Proxy)

1. Agent Skill | 2. Developer Interfaces | 3. Guidance

Exports | Manual exports | Imports | Functions | S3 | S4 | Compiled code

Generics | Classes | Methods | Methods for generics in other packages

It's dangerous to change state | The base solution: on.exit() | defer() is the foundation of withr | Last-in, first-out | "Local" functions (and "with" functions) | Deferring events on the global environment

Initial setup and dev workflow | Code formatting | Code organization | Naming conventions | Vector classes | Coercion functions | Protection | Protect list | Unwind Protect

1. What are the underlying types of cpp11 objects? | 2. How do I add elements to a list? | 3. Does cpp11 support default arguments? | 4. How do I create a new empty list? | 5. How do I retrieve (named) elements from a named vector/list? | 6. How can I tell whether a vector is named? | 7. How do I return a cpp11::writable::logicals object with only a FALSE value? | 8. How do I create a new empty environment? | 9. How do I assign and retrieve values in an environment? What happens if I try to get a value that doesn't exist? | 10. How can I create a cpp11:raws from a std::string? | 11. How can I create a std::string from a cpp11::writable::string? | 12. What are the types for C++ iterators? | 13. My code has using namespace std, why do I still have to include std:: in the signatures of [[cpp11::register]] functions? | 14. How do I modify a vector in place? | 15. Should I call cpp11::unwind_protect() manually? | Destructors | Nested unwind_protect() | 16. Ok but I really want to call cpp11::unwind_protect() manually

Introduction | Outline | Prerequisites | Getting started with C++ | No inputs, scalar output | Scalar input, scalar output | Vector input, scalar output | Vector input, vector output | Using cpp_source | Exercises | Other classes | Lists and data frames | Functions | Attributes | Missing values | Scalars | Integers | Doubles | Strings | Boolean | Vectors | Standard Template Library | Using iterators | Algorithms | Data structures | Vectors | Sets | Case studies | Gibbs sampler | R vectorisation versus C++ vectorisation | Using cpp11 in a package | Learning more

Motivations | Copy-on-write semantics | Improve safety | C safety | C++ safety | Altrep support | Altrep benchmarks | UTF-8 everywhere | C++11 features | Simpler implementation | Compilation speed | Header only | Vendoring | Protection | Growing vectors | Conclusion

Core Concepts | Key Takeaways | 1. Basic mirai Usage | Create and Access Results | Passing Data | 2. Local Daemons | Basic Setup | Daemon Configuration | Synchronous Mode (Testing/Debugging) | 3. Remote Daemons - SSH Direct | Setup Host to Accept Remote Connections | URL Constructors | SSH Configuration | 4. Remote Daemons - SSH Tunnelling | When to Use Tunnelling | Setup | 5. HPC Cluster Configurations | General Pattern | Scheduler-Specific Directives | 6. HTTP Launcher | 7. Manual Daemon Deployment | Generate Launch Commands | 8. Compute Profiles | Multiple Independent Profiles | Scoped Profiles | 9. Common Patterns | Temporary Daemons | Mixed Local/Remote Resources | Dynamic Scaling | 10. mirai_map - Parallel Map | Basic Usage | Collection Options | Multiple Map (over DataFrame/Matrix) | 11. Error Handling | 12. Monitoring | 13. Advanced Features | Timeouts | Cancellation | Evaluation Everywhere | Random Seeds (Reproducible) | Custom Serialization | TLS Configuration | 14. Dispatcher vs. Direct | 15. Quick Decision Tree | 16. Common Gotchas

Enabling markdown support | Basic syntax | Sections and subsections | Inline formatting | Code | Lists | Tables | Links | Images | Function links | Code chunks | Chunk options | Possible problems | Some Rd tags can't contain markdown | Mixing Markdown and Rd markup | Leading white space | Spurious lists

Exporting | The introduction | Title | Description | Details | Required tags | Inputs | Outputs | Examples | Usage

Classes | Fields and active bindings | Methods | Dynamic methods | Opting out

Generics | Classes | Methods

See also | Family | References | Aliases | Search | Back references

Multiple functions in the same topic | @rdname | @describeIn | Order of includes | Automatically copy tags | Parameters | Recursive inheritance | Multiple parameters | The dot prefix | Inheriting other components | Documenting ... | Inheriting from other packages | Custom tags | Inline code | Inline Rd code | Child documents | Superseded

RSA / ECDSA keys | AES/HMAC keys

Directory functions | File functions | Path functions

The Remotes field | GitHub | Other sources | CRAN submission

About this case study | Overview | Problem statement | User prompt | Iteration 1: Initial profiling | Running debrief | Debrief output (key sections) | How I interpreted this output | Optimization applied | Result | Iteration 2: Finding the next bottleneck | Debrief output after first optimization | Iteration 3: Diminishing returns | Debrief output (using 10 trees for better sampling) | Why I only used pv_print_debrief() | Functions I didn't use | When pv_print_debrief() alone is sufficient | When to use the other functions | Final results

Writing YAML with ymlthis | Parameterized reports | References and citations | R Markdown extensions | R Markdown workflows | YAML add-in | Writing to files | Placing YAML on your clipboard | Working with yml objects

Introduction | Locally | Ask each time | Environment variables | Keyring | Sharing with others | Reprexes | GitHub | Travis | CRAN | Documentation | Vignettes | Testing

Core Concepts | Key Takeaways | 1. Sockets and Connections | Create Sockets | Protocols | Transports | 2. Send and Receive | Synchronous | Receive Modes | 3. Async I/O | Basic Async | Non-blocking Patterns | 4. Condition Variables | Basics | Pipe Notifications | Async with CV | 5. Request/Reply (RPC) | Server | Client | 6. Pub/Sub | 7. Surveyor/Respondent | 8. TLS Secure Connections | Self-signed Certificates | CA Certificates | 9. Options and Statistics | Get/Set Options | Common Options | Custom Serialization | Statistics | 10. Contexts | 11. Cross-language Exchange | R to Python (NumPy) | 12. Error Handling | 13. Utilities

1. TLS Secure Connections | 2. Options | 3. Custom Serialization | 4. Statistics

1. Cross-language Exchange | 2. Async and Concurrency | 3. Synchronisation Primitives

Key choices | User-facing auth | Auth state | OAuth client | API key | Email or Google identity | Scopes | OAuth cache and Out-of-band auth | Overview of mechanics | Getting that first token | Auth interface | De-auth | Bring Your Own Client and Key | Changing identities (and more)

Why change was needed | How to instantiate an OAuth client in R | AuthState class | Gargle2.0 class

Basics | Percent class | format() method | Casting and coercion | Double dispatch | Percent class | Decimal class | Cached sum class | Record-style objects | Rational class | Decimal2 class | Equality and comparison | Polynomial class | Make an atomic polynomial vector | Implementing equality and comparison | Arithmetic | Cached sum class | Meter class | Implementing a vctrs S3 class in a package | Getting started | Low-level and user-friendly constructors | Other helpers | Testing | Existing classes

Performance

What is YAML? | Parsing YAML | Scalars | Sequences | Maps | Custom handlers | Sequence handlers | Map handlers | Emitting YAML | Formatting options | indent | indent.mapping.sequence | column.major | YAML 1.2 logical handling | Verbatim text | Quoted strings | Custom tags

Writing the linter | Writing linter tests | Other utilities for writing custom linters | Contributing to | More details about writing tests for new {lintr} linters | Adding your linter to the default_linters | Submit pull request

1. Mirai Parallel Clusters | 2. Foreach Support

1. Introduction | 2. Automatic Tracing Setup | 3. Span Types and Hierarchy | 3.1 Core Span Types | 3.2 Span Relationships and Context Propagation | 4. Status and Error Tracking | 5. Monitoring and Observability | 6. Integration with Observability Platforms

Do you need it? | Expectation basics | Testing your expectations | Examples | expect_vector_length() | expect_s3_class() | Optional class | Repeated code

OAuth client | Auth | Compose and send an email | Read email | Quota

Demo code | Setup: store a token | Usage: load and use token | Ongoing maintenance

Constructing a MIME message | Text | HTML | Attachments | Including images | Uploading | Create Draft | Insert | Import | Sending | Draft | Message | Troubleshooting | Gmail API error 400: Mail service not enabled

Modifying Existing XML | Text Modification | Attribute and Namespace Definition Modification | Name Modification | Node modification | Replacing existing nodes | Add a sibling | Add a child | Removing nodes | Namespaces

Options and environment variables | Random numbers | Some tests can't be run in some circumstances | HTTP requests | Graphics | User interaction | User-facing text | Repeated code

Activating | Changes | Deprecations | Warnings | Messages | waldo | Reproducible output | Upgrading | Alternatives

A systemfonts based workflow | Using ragg | Extra font styles | Fonts from other places | Font embedding in SVG | Want more?

Digital typography | Typeface or font? | Font files | Text shaping | Font handling in R | Fonts and text from a user perspective | Fonts and text from a graphics device perspective

Font matching | Glyph metrics | Retrieving cached freetype face | Check for Freetype compatibility | Font fallback | Font Weight | Family name | Emoji location

Create a request | Perform a request and fetch the response | Control the request process

Theming | Images

Process | Setup | Backport changes | Publish | Context | Automatic development mode | Publishing | Construct a branch for the update | Problem-solving

Metadata | Accessibility | Home page | Reference | Articles | News | Publishing | Promoting

Necessary configuration | Site-wide customization | Article metadata

Getting started with mocking | Case studies | Pretending we're on a different platform | Speeding up tests | Managing time | How does mocking work?

Basics | Helpers | Embedding skip() in package functions

Basic workflow | Snapshot format | Interactive usage | Testing errors | Other challenges | Varying outputs | local_reproducible_output() | Snapshotting graphics | Snapshotting values | Whole file snapshotting | Previous work

Test hygiene | local_ helpers | Foundations | on.exit() | withr::defer() | "Local" helpers | Case study: usethis | Scope | File | Package | Other challenges

A slightly less cascading style specification | Styles | Style sets | Inheritance | Sizing | Side values

Mocks | Creating a mock function | Return values | Cycling through return values | Evaluating expression in an environment of choice | Integration with with_mocked_bindings() | Simple integration | Verifying the number of calls | Verify the call signature | Verify values of argument | Further reading

Running lintr on a project | Configuring linters | The .lintr file | .lintr File Example | Other configuration options | Using options() | Using arguments to lint() | Defaults | Customizing active linters | Using all available linters | Advanced: programmatic retrieval of linters | Exclusions | Excluding lines of code | Excluding only some linters | Excluding multiple lines of codes | Excluding lines via the config file | Excluding files completely | Excluding directories completely

Setup | Basic operation | Common problems | Performance | Reporters | Default reporters | Parallel support | Writing parallel reporters | Parallel updates

Stable | Deprecated | Superseded | Experimental | Superseded stages | Questioning | Maturing

The XOR operator | Stream ciphers | Symmetric encryption | Public-key encryption and Diffie-Hellman

The XOR operator | Stream ciphers | Symmetric encryption | Public-key encryption and Diffie-Hellman

String width | String shape

Altrep Functions | Converting Functions | Helper Functions | FAQ

Getting Started | Unpacking a returned value | Example: Intercept and slope of regression | Example: Unpacking the result of safely | Unpacking a data frame | Example: List of data frames | Custom classes | Trailing values: the "everything else" clause | Leading values and middle values | Skipped values: anonymous elements | Default values: handle missing values | Swapping values

PAT and host | The gitcreds package | PAT in an environment variable | Recommendations | Failure

Requirements | An example | Use in ggplot2 | The marquee geom | The marquee element | A bit about images | A bit about tables | Wrapping up

Markdown vs CommonMark | Standard Markdown syntax | Block elements | Paragraphs (p) | Headers (h1-h6) | Block quotes (bq) | Code blocks (cb) | Lists (ul, ol, and li) | Horizontal rulers (hr) | Span elements | Emphasize (em) | Strong (str) | Link (a) | Code (code) | Images (img) | Markdown extensions | Underline (u) | Strikethrough (del) | Custom spans | Miscellaneous | Escaping syntax | Where is my HTML-support?

Operation | GitHub Actions | Limitations | Supported features | Inline formatting | Code | Figures | Equations | Cross references | To do

Iterators | Iterating | Adapting generators

bit type | bitwhich type | processing chunks

A performance example | Boolean data types | % memory consumption of filter | % time extracting | % time assigning | % time subscripting with 'which' | % time assigning with 'which' | % time Boolean NOT | % time Boolean AND | % time Boolean OR | % time Boolean EQUALITY | % time Boolean XOR | % time Boolean SUMMARY | Fast methods for integer set operations | % time for sorting | % time for unique | % time for duplicated | % time for anyDuplicated | % time for sumDuplicated | % time for match | % time for in | % time for notin | % time for union | % time for intersect | % time for setdiff | % time for symdiff | % time for setequal | % time for setearly

Boolean data types | Available classes | Available methods | Creating and manipulating | Coercion | Boolean operations | Manipulation methods | Aggregation methods for booltype | Fast methods for integer set operations | Methods using random access to bit vectors | Methods using bit vectors for sorting integers | Methods for sets of sorted integers

Before we start | Selections as dots or as named arguments | Do you need tidyselect? | The selection evaluators | Defusing and resuming evaluation of R code | Resuming defused R code with tidyselect rules | Simple selections with dots | Simple selections with named arguments | Renaming selections | Creating selection helpers | Handling duplicate variables

Sets of variables | Bare names | The : operator | Boolean operators | Dots and c() | Renaming variables | Name combination and propagation | Set combination with named variables | Predicate functions | Selection helpers | Supported data types | Evaluation | Data-expressions and env-expressions | Arithmetic operators | Selecting versus renaming | All renaming inputs must be named | Renaming to an existing variable name | Duplicate columns in data frames | Acknowledgements

Performance focused changes across versions | vr packageVersion('gtable')

JSON Logs | logfmt Logs

JSON Web Token: HMAC tagging | JSON Web Token: RSA/ECDSA signature | Reserved jwt-claim names | Where is the JSON

Introduction | Getting started | Navigating profvis | The data view | How profiling data is collected

Test files | Helper files | Setup files | Teardown files | Snapshot files | Other files and folders

Getting started | Cheatsheet | Vectors | Other objects | Functions | R functions | Unsupported Rcpp features | RNGs | Common issues when converting | STL includes | Strict headers | R API includes | Type aliases | Logical vector construction

How styler works | Implementation details | Showcasing the development of a styling rule | Cache invalidation

Reference implementations | Design patterns

For packages | GitHub Actions | For projects | Super-Linter

Entry-points | Passing arguments to the style guide | Invasiveness | scope: What to style? | How strict do you want styler to be? | Ignoring certain lines | Caching | Dry mode | More configuration options | Roxygen code example styling | Custom math token spacing | Custom indention | Custom style guides

Package remotes | GitHub | Other sources | CRAN submission

Prototype | Base prototypes | Coercing to common type | Casting to specified type | Size | Slicing | Common sizes: recycling rules | Appendix: recycling in base R

Two types of remotes | Special note for Windows | Part 1: Storing HTTPS credentials | Accessing the HTTPS Credential Store from R | Setting your GITHUB_PAT | Non-interactive use | Part 2: Managing SSH Keys | Generating a key

httr quickstart guide

Introduce yourself to Git | Local repository basics

Introduce yourself to Git | Local repository basics

Overview | Examples | Details | Function calls | Comments | Assignment

Theory | Practice | Some other rules and their transformers

The current local time | The current time somewhere else | Set a meeting across time zones | High level API | Force a specific time zone | Finding the next Monday (or Thursday) | Generate sequences of dates and date-times | Grouping by months or quarters | Flooring by days | Day of the year | Computing an age in years | Computing number of weeks since the start of the year | Compute the number of months between two dates | Computing the ISO year or week | Computing the Epidemiological year or week | Converting a time zone abbreviation into a time zone name | When is the next daylight saving time event?

Why can't I do day arithmetic on a year-month-day? | Why can't I add time to a zoned-time? | Where did my POSIXct subseconds go? | What is the time zone of Date? | What does clock do with leap seconds? | Why doesn't this work with data.table?

Definitions | Examples | c() and vctrs::vec_c() | Atomic vectors | Incompatible vectors and non-vectors | Factors | Date-times | Dates and date-times | Missing values | Data frames | Matrices and arrays | Implementation | ifelse()

Using Sodium | Random data generator | Hash functions | Secret key encryption | Secret key authentication | Public key encryption | Public key authentication (signatures) | Public key authenticated encryption

Using Sodium | Random data generator | Hash functions | Secret key encryption | Secret key authentication | Public key encryption | Public key authentication (signatures) | Public key authenticated encryption

Prerequisites | Using in a tibble | Fixing the data type | Custom rendering | Truncation | Adaptive rendering | Testing

Basic YAML | LaTeX/PDF Options | R Markdown Websites | Citations | blogdown YAML | bookdown YAML | pkgdown YAML | pagedown YAML | distill YAML | rticles YAML | RStudio Connect Scheduled Email YAML

Basic syntax | Types in YAML | Sources of YAML

General remarks | Credential helper survey | cache | store | osxkeychain | manager-core (on macOS), before version 2.0.246-beta | manager-core (macOS), 2.0.246-beta or later | manager (GitHub authority) | manager (Basic authority) | manager-core (on Windows, before version 2.0.246-beta) | manager-core (on Windows, from 2.0.246-beta) | Recommendations for multiple accounts | macOS | Windows, with git 2.29.0 or later and manager-core | Windows with older git versions | At most one github.com credential | Multiple GitHub credentials

Scaling SVG outputs | Fluid scaling | Natural scaling | Internal notes | Device scaling | Scaling of graphical elements | SVG output

Building | Parsing | Parsing dates | Parsing date-times | date_time_parse() | date_time_parse_complete() | date_time_parse_abbrev() | date_time_parse_RFC_3339() | Grouping, rounding and shifting | Grouping | Rounding | Shifting | Arithmetic | Getting and setting

slide() | slide_index() | slide_period()

slide() | tile() | stretch()

Row-wise iteration | Varying parameter combinations | Sliding inside a mutate()

Executing a C function later | Background tasks