Package index • projr

Core workflow

Main functions for project workflow

projr_init() projr_init_all() projr_init_renv() projr_init_cite() projr_init_git() projr_init_github() projr_init_license(): Initialize a projr Project
projr_init_prompt(): Initialise project
projr_build() projr_build_major() projr_build_minor() projr_build_patch(): Build project to output
projr_build_dev(): Build dev project
projr_build_check_packages(): Check if required packages for build are available
projr_restore_repo() projr_restore_repo_wd() projr_restore(): Restore project artefact directories

Path helpers

Functions for getting project paths

projr_path_get(): Return path
projr_path_get_dir(): Return path to profile-specific directory
projr_path_get_cache_build_dir() projr_path_get_cache_build(): Get projr build cache directory

Initialisation helpers

Helper functions for project initialisation

projr_init() projr_init_all() projr_init_renv() projr_init_cite() projr_init_git() projr_init_github() projr_init_license(): Initialize a projr Project
projr_init_renviron(): Set environment variables for projr_init

Version management

Functions for managing project versions

projr_version_get(): Returns project version
projr_version_set(): Set Project Version

Manifest queries

Functions for querying manifest to track file changes across versions

projr_manifest_changes() projr_manifest_range() projr_manifest_last_change(): Query Files Changed Between Versions
projr_manifest_file_last_change() projr_manifest_file_changed() projr_manifest_file_history() projr_manifest_file_first(): Query When a Specific File Last Changed

YAML configuration

Functions for managing _projr.yml configuration

projr_yml_get(): Get active projr settings and checks for validity
projr_yml_check(): Check active projr settings.
projr_yml_git_set() projr_yml_git_set_default(): Set Git options
projr_yml_cite_set() projr_yml_cite_set_default(): Set citation options
projr_yml_dir_path_set() projr_yml_dir_path_rm(): Set directory path
projr_yml_dir_license_set(): Set license for a directory
projr_yml_dir_license_get(): Get license configuration for a directory
projr_yml_dir_license_rm(): Remove license configuration for a directory
projr_yml_dir_license_update(): Update LICENSE files with current DESCRIPTION authors
projr_yml_dest_add_github(): Add a GitHub release as a destination
projr_yml_dest_add_local(): Add a local directory as a destination
projr_yml_dest_add_osf() projr_yml_dest_add_osf_proj() projr_yml_dest_add_osf_comp(): Add an OSF node as a destination
projr_yml_par_add(): Add the parameters key
projr_yml_script_add() projr_yml_script_rm() projr_yml_script_rm_all() projr_yml_script_add_pre() projr_yml_script_add_post(): Build script-related functions
projr_yml_hooks_add() projr_yml_hooks_rm_all() projr_yml_hooks_add_pre() projr_yml_hooks_add_post(): Build hook-related functions
projr_yml_restrictions_set(): Set build restrictions
projr_license_create_manual(): Manually create LICENSE files without YAML configuration

Profile management

Functions for managing project profiles

projr_profile_create(): Add projr profile file
projr_profile_delete(): Delete a projr profile from _projr.yml
projr_profile_get(): Get active projr profile

Parameters

Functions for managing project parameters

projr_par_get() projr_param_get(): Get project parameters

Environment management

Functions for managing environment variables

projr_env_set(): Set environment variables from files

Git ignore management

Functions for managing .gitignore and .Rbuildignore

projr_ignore() projr_ignore_dir() projr_ignore_file() projr_ignore_file_git() projr_ignore_dir_git() projr_ignore_file_rbuild() projr_ignore_dir_rbuild(): Manually Ignore Files or Directories in .gitignore and .Rbuildignore
projr_ignore_auto(): Update .gitignore and .Rbuildignore with projr-managed ignores
projr_unignore_manual() projr_unignore_manual_dir() projr_unignore_manual_file() projr_unignore_manual_file_git() projr_unignore_manual_dir_git() projr_unignore_manual_file_rbuild() projr_unignore_manual_dir_rbuild(): Manually Unignore Files or Directories in .gitignore and .Rbuildignore

renv helpers

Functions for managing renv dependencies

projr_renv_restore() projr_renv_update() projr_renv_restore_and_update(): Restore or Update renv Lockfile Packages
projr_renv_test(): Test renv restore

Data helpers

Functions for managing project data

projr_use_data(): projr drop-in replacement for usethis::use_data

OSF helpers

Functions for Open Science Framework integration

projr_osf_create_project(): Create a new project on OSF
projr_instr_auth_github() projr_instr_auth_osf(): Two-minutes or less authorisation instructions

GitHub helpers

Functions for GitHub integration

projr_instr_auth_github() projr_instr_auth_osf(): Two-minutes or less authorisation instructions

Changelog

Functions for managing changelog

projr_cat_changelog(): Cat useful information

Build logging

Functions for managing build logs

projr_log_clear(): Clear build logs

Internal utilities

Internal helper functions (not exported)

.yml_get(): Get active projr settings and do no check
projr_profile_create_local(): Create a local projr profile
projr_profile_delete_local(): Delete local projr settings file.