Learn R Programming

⚠️There's a newer version (0.11.1) of this package.Take me there.

ProjectTemplate (version 0.10.4)

Automates the Creation of New Statistical Analysis Projects

Description

Provides functions to automatically build a directory structure for a new R project. Using this structure, 'ProjectTemplate' automates data loading, preprocessing, library importing and unit testing.

Copy Link

Version

Install

install.packages('ProjectTemplate')

Monthly Downloads

1,043

Version

0.10.4

License

GPL-3 | file LICENSE

Maintainer

Kenton White

Last Published

November 19th, 2023

Functions in ProjectTemplate (0.10.4)

.attach.or.add.namespace

Attach a package or add a namespace
.add.extension

Associate a reader function with an extension.
cache.project

Cache a project's data sets in binary format.
cache

Cache a data set for faster loading.
.cache.status

Print the current cache status
.cached.variables

List all cached variables
.check.version

Compare the project version with the current ProjectTemplate version
.cache.format

Get configured cache file format strategy
.convert.to.data.table

Convert one or more data sets to data.tables
.list.data

Build the list of data available for loading into memory
.list.files.and.dirs

List all files and directories, excluding .. and .
translate.dcf

Read a DCF file into an R list.
clean.variable.name

Translate a file name into a valid R variable name.
clear

Clear objects from the global environment
create.project

Create a new project.
.has.project

Check if the project was loaded
.cache.filename

Construct the file names for the cache and hash
create.template

Create a new template
get.project

Show information about the current project.
.create.project.existing

Create a project structure
.cache.hash

Calculate the hash of the data stored in a variable
.init.logger

Initialize the logger for the project
.is.cached

Check whether variables are cached
.convert.to.tibble

Convert one or more data sets to tibbles
.is.dir

Check if path is an existing directory
.stopifproject

Raise an error if given path is a valid project
.load.libraries

Load the libraries listed in the configuration into memory
.create.cache.hash

Create a data.frame with the cache metadata
.munge.data

Source all munge scripts
.is.ProjectTemplate

Test whether a given path is a ProjectTemplate project
.dir.empty

Check if a directory is empty
.load.data

Load the data from the cache and data directories
.evaluate.code

Run code and assign the results to variable
.is.cache.empty

Check whether the cache is empty
.rstudioprojectfile

Return an RStudio project file as character vector
.stopifnotproject

Raise an error if given path is not a valid project
.load.helpers

Load the helper functions
.prepare.data.ignore.regex

Prepare a regular expression for matching files to be ignored
migrate.template

Migrate a template to a new version of ProjectTemplate
preinstalled.readers

Automatically read data into memory
.get.template

Get the location of a template from its name
.provide.directory

Make sure a required directory exists before usage
loadproject_addin

Load Project
.unload.project

Unload the project variables keeping the data
migrate.project

Migrates a project from a previous version of ProjectTemplate
.var.diff.from

Compare sets of variable names
.package.version

Get the current ProjectTemplate version
.write.cache

Write a variable and its metadata to cache
reloadproject_addin

Reload Project
.parse.extensions

Match readers to the extensions of the data files
require.package

Require a package for use in the project
.remove.sticky.vars

Remove variables to keep from a list of candidates for removal
.require.package

Require internal package
.quietstop

Stop silently
.read.cache.info

Read metadata for a variable in the cache
project.config

ProjectTemplate Configuration file
reload.project

Reload or reset a project
stub.tests

Generate unit tests for your helper functions.
load.project

Automatically load data and packages for a project.
list.data

Listing the data for the current project
run.project

Run all of the analyses in the src directory.
test.project

Run all unit tests for this project.
show.project

Show information about the current project.
ProjectTemplate-package

ProjectTemplate: Automates the Creation of New Statistical Analysis Projects
add.config

Add project specific config to the global config
cache.name

Translate a variable name into a file name for caching.
clear.cache

Clear data sets from the cache