ProjectTemplate: Automates the Creation of New Statistical Analysis Projects

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.

AuthorAleksandar Blagotic [ctb], Diego Valle-Jones [ctb], Jeffrey Breen [ctb], Joakim Lundborg [ctb], John Myles White [aut, cph], Josh Bode [ctb], Kenton White [ctb, cre], Kirill Mueller [ctb], Matteo Redaelli [ctb], Noah Lorang [ctb], Patrick Schalk [ctb], Dominik Schneider [ctb]
Date of publication2016-08-11 12:26:17
MaintainerKenton White <jkentonwhite@gmail.com>
LicenseArtistic-2.0
Version0.7
http://projecttemplate.net

View on CRAN

Man pages

add.extension: Associate a reader function with an extension.

arff.reader: Read the Weka file format.

cache: Cache a data set for faster loading.

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

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

clean.variable.name: Translate a file name into a valid R variable name.

create.project: Create a new project.

csv2.reader: Read a semicolon separated values (.csv2) file.

csv.reader: Read a comma separated values (.csv) file.

dbf.reader: Read an XBASE file with a .dbf file extension.

db.reader: Read a SQlite3 database with a (.db) file extension.

default.config: Default configuration

epiinfo.reader: Read an Epi Info file with a .rec file extension.

file.reader: Read an arbitrary file described in a .file file.

get.project: Show information about the current project.

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

migrate.project: Migrates a project from a previous version of ProjectTemplate

mp3.reader: Read an MP3 file with a .mp3 file extension.

mtp.reader: Read a Minitab Portable Worksheet with an .mtp3 file...

new.config: Configuration for new projects

octave.reader: Read an Octave file with a .m file extension.

ppm.reader: Read a PPM file with a .ppm file extension.

preinstalled.readers: Maps file types to the reader functions used to autoload...

ProjectTemplate: Automates the creation of new statistical analysis projects.

rdata.reader: Read an RData file with a .rdata or .rda file extension.

reload.project: Reload a project from scratch.

require.package: Require a package for use in the project

r.reader: Read an R source file with a .R file extension.

run.project: Run all of the analyses in the 'src' directory.

show.project: Show information about the current project.

spss.reader: Read an SPSS file with a .sav file extension.

sql.reader: Read a database described in a .sql file.

stata.reader: Read a Stata file with a .stata file extension.

stub.tests: Generate unit tests for your helper functions.

systat.reader: Read a Systat file with a .sys or .syd file extension.

test.project: Run all unit tests for this project.

translate.dcf: Read a DCF file into an R list.

tsv.reader: Read a tab separated values (.tsv or .tab) file.

url.reader: Read a remote file described in a .url file.

wsv.reader: Read a whitespace separated values (.wsv or .txt) file.

xls.reader: Read an Excel 2004 file with a .xls file extension.

xlsx.reader: Read an Excel 2007 file with a .xlsx file extension.

xport.reader: Read an XPort file with a .xport file extension.

Files in this package

ProjectTemplate
ProjectTemplate/inst
ProjectTemplate/inst/example_data
ProjectTemplate/inst/example_data/example_31.db
ProjectTemplate/inst/example_data/example_33.file
ProjectTemplate/inst/example_data/example_10.wsv.bz2
ProjectTemplate/inst/example_data/example_39.dta
ProjectTemplate/inst/example_data/example_41.xport
ProjectTemplate/inst/example_data/example_27.xlsx
ProjectTemplate/inst/example_data/sqlite3_examples.sql
ProjectTemplate/inst/example_data/example_29.db
ProjectTemplate/inst/example_data/example_08.tsv.gz
ProjectTemplate/inst/example_data/example_32.arff
ProjectTemplate/inst/example_data/example_35.ppm
ProjectTemplate/inst/example_data/example_36.dbf
ProjectTemplate/inst/example_data/example_07.tsv.zip
ProjectTemplate/inst/example_data/example_16.tab
ProjectTemplate/inst/example_data/example_30.db
ProjectTemplate/inst/example_data/example_19.tab.gz
ProjectTemplate/inst/example_data/example_17.tab.bz2
ProjectTemplate/inst/example_data/example_38.sav
ProjectTemplate/inst/example_data/example_14.rda
ProjectTemplate/inst/example_data/example_12.wsv.gz
ProjectTemplate/inst/example_data/foo.reader.R
ProjectTemplate/inst/example_data/example_22.txt.zip
ProjectTemplate/inst/example_data/example_24.R
ProjectTemplate/inst/example_data/example.foo
ProjectTemplate/inst/example_data/example_23.txt.gz
ProjectTemplate/inst/example_data/example_20.txt
ProjectTemplate/inst/example_data/example_25.r
ProjectTemplate/inst/example_data/example_02.csv.bz2
ProjectTemplate/inst/example_data/example_04.csv.gz
ProjectTemplate/inst/example_data/example_40.dta
ProjectTemplate/inst/example_data/example_13.RData
ProjectTemplate/inst/example_data/example_11.wsv.zip
ProjectTemplate/inst/example_data/example_09.wsv
ProjectTemplate/inst/example_data/example_42.xpt
ProjectTemplate/inst/example_data/example_26.xls
ProjectTemplate/inst/example_data/example_21.txt.bz2
ProjectTemplate/inst/example_data/example_06.tsv.bz2
ProjectTemplate/inst/example_data/example_28.db
ProjectTemplate/inst/example_data/example_03.csv.zip
ProjectTemplate/inst/example_data/example_05.tsv
ProjectTemplate/inst/example_data/example_37.sav
ProjectTemplate/inst/example_data/example_15.url
ProjectTemplate/inst/example_data/example_18.tab.zip
ProjectTemplate/inst/example_data/example_01.csv
ProjectTemplate/inst/defaults
ProjectTemplate/inst/defaults/full
ProjectTemplate/inst/defaults/full/logs
ProjectTemplate/inst/defaults/full/logs/README.md
ProjectTemplate/inst/defaults/full/cache
ProjectTemplate/inst/defaults/full/cache/README.md
ProjectTemplate/inst/defaults/full/TODO
ProjectTemplate/inst/defaults/full/tests
ProjectTemplate/inst/defaults/full/tests/1.R
ProjectTemplate/inst/defaults/full/tests/README.md
ProjectTemplate/inst/defaults/full/src
ProjectTemplate/inst/defaults/full/src/README.md
ProjectTemplate/inst/defaults/full/src/eda.R
ProjectTemplate/inst/defaults/full/lib
ProjectTemplate/inst/defaults/full/lib/helpers.R
ProjectTemplate/inst/defaults/full/lib/README.md
ProjectTemplate/inst/defaults/full/graphs
ProjectTemplate/inst/defaults/full/graphs/README.md
ProjectTemplate/inst/defaults/full/data
ProjectTemplate/inst/defaults/full/data/README.md
ProjectTemplate/inst/defaults/full/README.md
ProjectTemplate/inst/defaults/full/config
ProjectTemplate/inst/defaults/full/config/global.dcf
ProjectTemplate/inst/defaults/full/config/README.md
ProjectTemplate/inst/defaults/full/diagnostics
ProjectTemplate/inst/defaults/full/diagnostics/1.R
ProjectTemplate/inst/defaults/full/diagnostics/README.md
ProjectTemplate/inst/defaults/full/doc
ProjectTemplate/inst/defaults/full/doc/README.md
ProjectTemplate/inst/defaults/full/munge
ProjectTemplate/inst/defaults/full/munge/README.md
ProjectTemplate/inst/defaults/full/munge/01-A.R
ProjectTemplate/inst/defaults/full/reports
ProjectTemplate/inst/defaults/full/reports/README.md
ProjectTemplate/inst/defaults/full/profiling
ProjectTemplate/inst/defaults/full/profiling/1.R
ProjectTemplate/inst/defaults/full/profiling/README.md
ProjectTemplate/inst/defaults/config
ProjectTemplate/inst/defaults/config/default.dcf
ProjectTemplate/tests
ProjectTemplate/tests/run-all.R
ProjectTemplate/tests/testthat
ProjectTemplate/tests/testthat/test-readers.R
ProjectTemplate/tests/testthat/test-require.R
ProjectTemplate/tests/testthat/test-add_extension.R
ProjectTemplate/tests/testthat/test-create.R
ProjectTemplate/tests/testthat/test-version.R
ProjectTemplate/tests/testthat/test-load.R
ProjectTemplate/tests/testthat/test-autogen.R
ProjectTemplate/tests/testthat/test-varnames.R
ProjectTemplate/tests/testthat/test-migration.R
ProjectTemplate/tests/testthat/test-config.R
ProjectTemplate/tests/testthat/migration
ProjectTemplate/tests/testthat/migration/0.5-2
ProjectTemplate/tests/testthat/migration/0.5-2/config
ProjectTemplate/tests/testthat/migration/0.5-2/config/global.dcf
ProjectTemplate/tests/testthat/migration/0.5
ProjectTemplate/tests/testthat/migration/0.5/config
ProjectTemplate/tests/testthat/migration/0.5/config/global.dcf
ProjectTemplate/NAMESPACE
ProjectTemplate/R
ProjectTemplate/R/csv.reader.R ProjectTemplate/R/create.project.R ProjectTemplate/R/ppm.reader.R ProjectTemplate/R/clean.variable.name.R ProjectTemplate/R/preinstalled.readers.R ProjectTemplate/R/cache.name.R ProjectTemplate/R/url.reader.R ProjectTemplate/R/stub.tests.R ProjectTemplate/R/csv2.reader.R ProjectTemplate/R/wsv.reader.R ProjectTemplate/R/r.reader.R ProjectTemplate/R/translate.dcf.R ProjectTemplate/R/add.extension.R ProjectTemplate/R/sql.reader.R ProjectTemplate/R/systat.reader.R ProjectTemplate/R/load.project.R ProjectTemplate/R/reload.project.R ProjectTemplate/R/file.reader.R ProjectTemplate/R/new.config.R ProjectTemplate/R/get.project.R ProjectTemplate/R/cache.R ProjectTemplate/R/test.project.R ProjectTemplate/R/require.package.R ProjectTemplate/R/help.R ProjectTemplate/R/mp3.reader.R ProjectTemplate/R/db.reader.R ProjectTemplate/R/stata.reader.R ProjectTemplate/R/run.project.R ProjectTemplate/R/xport.reader.R ProjectTemplate/R/tsv.reader.R ProjectTemplate/R/arff.reader.R ProjectTemplate/R/cache.project.R ProjectTemplate/R/xls.reader.R ProjectTemplate/R/migrate.project.R ProjectTemplate/R/show.project.R ProjectTemplate/R/dbf.reader.R ProjectTemplate/R/epiinfo.reader.R ProjectTemplate/R/octave.reader.R ProjectTemplate/R/spss.reader.R ProjectTemplate/R/rdata.reader.R ProjectTemplate/R/default.config.R ProjectTemplate/R/xlsx.reader.R ProjectTemplate/R/mtp.reader.R
ProjectTemplate/MD5
ProjectTemplate/DESCRIPTION
ProjectTemplate/man
ProjectTemplate/man/get.project.Rd ProjectTemplate/man/xlsx.reader.Rd ProjectTemplate/man/stub.tests.Rd ProjectTemplate/man/reload.project.Rd ProjectTemplate/man/require.package.Rd ProjectTemplate/man/add.extension.Rd ProjectTemplate/man/systat.reader.Rd ProjectTemplate/man/wsv.reader.Rd ProjectTemplate/man/rdata.reader.Rd ProjectTemplate/man/csv2.reader.Rd ProjectTemplate/man/octave.reader.Rd ProjectTemplate/man/new.config.Rd ProjectTemplate/man/file.reader.Rd ProjectTemplate/man/clean.variable.name.Rd ProjectTemplate/man/test.project.Rd ProjectTemplate/man/url.reader.Rd ProjectTemplate/man/spss.reader.Rd ProjectTemplate/man/xport.reader.Rd ProjectTemplate/man/create.project.Rd ProjectTemplate/man/xls.reader.Rd ProjectTemplate/man/dbf.reader.Rd ProjectTemplate/man/db.reader.Rd ProjectTemplate/man/default.config.Rd ProjectTemplate/man/epiinfo.reader.Rd ProjectTemplate/man/mp3.reader.Rd ProjectTemplate/man/cache.project.Rd ProjectTemplate/man/stata.reader.Rd ProjectTemplate/man/tsv.reader.Rd ProjectTemplate/man/cache.name.Rd ProjectTemplate/man/cache.Rd ProjectTemplate/man/show.project.Rd ProjectTemplate/man/ProjectTemplate.Rd ProjectTemplate/man/migrate.project.Rd ProjectTemplate/man/ppm.reader.Rd ProjectTemplate/man/run.project.Rd ProjectTemplate/man/translate.dcf.Rd ProjectTemplate/man/load.project.Rd ProjectTemplate/man/preinstalled.readers.Rd ProjectTemplate/man/mtp.reader.Rd ProjectTemplate/man/r.reader.Rd ProjectTemplate/man/arff.reader.Rd ProjectTemplate/man/csv.reader.Rd ProjectTemplate/man/sql.reader.Rd

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

All documentation is copyright its authors; we didn't write any of that.