No articles match
Getting Started with renvvv2 months ago
Installation | Core Functions | Bioconductor Packages | Automatic Project Activation | Comparison with Base renv
Build Process3 months ago
The projr Build Process | Overview | Stage 1: Pre-Build | Validation | Remote destination preparation | Documentation and dependency snapshot | Version calculation | Hooks | Output directory preparation | Pre-build git commit | Pre-build manifest | Stage 2: Build | Script selection | Document rendering | Script execution | Stage 3: Post-Build | Artifact finalization | Post-build manifest | Documentation updates | Post-build git commit | Remote distribution | Post-build hooks | Dev version bump | Git push | Manifest System | Logging | Output levels | Log files | Debugging a failed build | Build Function Quick Reference | projr_build_patch / projr_build_minor / projr_build_major | projr_build_dev | Configuration helpers | Complete Lifecycle Example | Further reading
Concepts3 months ago
Core concepts | Single-purpose directories | Directory labels | Safe vs unsafe directories | Versioned builds | Development vs final builds | Development builds | Final builds | Build phases | Manifests | Archiving and restoration | Archive strategies | Restoration | Profiles | Environment variables | Dependencies and renv | The whole game
Environment Variables3 months ago
Environment Files | File Format | Example Setup | Loading Variables | Profiles | Key Variables | Build Control | Authentication | Precedence | Required Variables | Tips | See Also
Get started3 months ago
Get started with projr | Installation | Quick start | Builds | Development builds | Production builds | Archiving outputs | Restoring a project | Default directories | Manifest | Configuration | Next steps
How-to guides3 months ago
1. Initialise a project | 2. Run a development build | 3. Run a final (versioned) build | 4. Archive artefacts | 5. Restore artefacts | 6. Define directories and labels | 7. Use profiles | 8. View and manage build logs | 9. Query the manifest | 10. Configure environment variables
intro3 months ago
Introduction | Installation | Workflow | Initialise the project | Build the project | Versioning | Sharing outputs | _projr.yml configuration | directories | build | Setting up GitHub | Steps
Restoring Artifacts3 months ago
Quick start | projr_restore_repo() | projr_restore_repo_wd() | projr_content_update() | Parameters | Authentication | Configuring remotes | Examples | New collaborator setup | Selective restoration in an existing project | Falling back between remotes | Notes | See also
Scripts and Hooks3 months ago
Build Scripts | Configuration format | Priority | Managing scripts with R | Example: separate dev and production scripts | Example: one-off builds | Build Hooks | Execution details | Managing hooks with R | Example: data preparation hook | Example: separate dev and production hooks | Tips | See Also
Sending to Remotes3 months ago
GitHub Destinations | Local Destinations | Customization Options | structure | send_cue | send_strategy | send_inspect | Complete Configuration Examples | Comprehensive GitHub setup | Local archive setup | Multiple remotes | Build Workflow | Best Practices | Quick Reference | See Also
Design6 months ago
Design philosophy | Design goals | 1. Minimal cognitive overhead | 2. Fail-safe iteration | 3. Automation without magic | 4. Reproducibility by default | Core design principles | Single-purpose directories | Versioned builds, not versioned files | Configuration in YAML, not code | Dev builds vs final builds | Git integration, not Git dependency | Architecture | Layered design | Function naming conventions | Configuration precedence | Manifest format | Design decisions | Why semantic versioning? | Why default to GitHub Releases? | Why clear _output before builds? | Why route dev builds to cache? | Why YAML not TOML/JSON? | Future directions | Potential enhancements | Comparison to alternatives | projr vs targets | projr vs workflowr | projr vs usethis | Conclusion
Destination Send Workflow6 months ago
Overview | Stage 1: Getting the Remotes | Stage 2: Building the Plan | Stage 3: Implementing the Plan | Complete Workflow | Configuration Parameters | Examples | Example 1: First Upload (No Remote Exists) | Example 2: Incremental Update (Files Changed) | Example 3: No Changes (Skip Upload) | Example 4: Latest Structure (Always Overwrite) | Trust and Manifest Validation | Performance Considerations | Debugging | See Also
Directory Licenses7 months ago
Overview | Two Approaches to Directory Licensing | Supported License Types | YAML Configuration (Automatic Approach) | Setting License Configurations | YAMLConfiguration Format | Build-Time Behavior | Managing YAML Configurations | Author Precedence | Manual License Creation | Creating Manual Licenses | Manual License Behavior | Choosing an Approach | Example Workflows | Workflow 1: Automatic Licensing | Workflow 2: Manual Licensing | Workflow 3: Mixed Approach | Best Practices | Troubleshooting | License Not Created During Build | Manual License Overwritten | Wrong Authors in License | See Also