From dac4d9b1d3191f82f5049b2c3edf98f1dad7b063 Mon Sep 17 00:00:00 2001 From: olhakholod Date: Wed, 10 Jan 2018 19:37:36 -0500 Subject: [PATCH] add eload function to projectInit --- DESCRIPTION | 15 +++++++-------- NAMESPACE | 1 + man/createOutputSubdir.Rd | 1 + man/createRootSubdir.Rd | 1 + man/dirData.Rd | 1 + man/dirOut.Rd | 1 + man/dirRaw.Rd | 1 + man/dirRes.Rd | 1 + man/dirWeb.Rd | 1 + man/dirWrap.Rd | 1 + man/eload.Rd | 12 ++++++++++++ man/findConfigFile.Rd | 1 + man/firstFile.Rd | 1 + man/go.Rd | 1 + man/penv.Rd | 1 + man/project.init.Rd | 1 + man/project.init2.Rd | 1 + man/projectInit.Rd | 8 ++++---- man/projectRefresh.Rd | 1 + man/refreshPackage.Rd | 1 + man/rp.Rd | 1 + man/setOutputSubdir.Rd | 1 + 22 files changed, 42 insertions(+), 12 deletions(-) create mode 100644 man/eload.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 7dc57c2..d8e452d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,17 +7,16 @@ Authors@R: c(person("Nathan", "Sheffield", email = "nathan@code.databio.org", role = c("aut", "cre"))) Maintainer: Nathan Sheffield Description: Makes it easy to initialize a customized workspace, relying on - shell environment variables to point easy function aliases so you can control - project-specific results directories, data inputs, shared temporary files, and - other resources + shell environment variables to point easy function aliases so you can control + project-specific results directories, data inputs, shared temporary files, and + other resources Imports: pryr, yaml Suggests: - knitr -Enhances: - Rcpp, - roxygen2 + knitr +Enhances: Rcpp, + roxygen2 VignetteBuilder: knitr License: GPL-3 -RoxygenNote: 6.0.1 +RoxygenNote: 5.0.1 diff --git a/NAMESPACE b/NAMESPACE index d641f14..560011f 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -7,6 +7,7 @@ export(dirOut) export(dirRaw) export(dirRes) export(dirWeb) +export(eload) export(findConfigFile) export(go) export(penv) diff --git a/man/createOutputSubdir.Rd b/man/createOutputSubdir.Rd index a647559..19cd0ff 100644 --- a/man/createOutputSubdir.Rd +++ b/man/createOutputSubdir.Rd @@ -11,3 +11,4 @@ createOutputSubdir(...) Helper function to silently create a subdirectory in the project output directory. } + diff --git a/man/createRootSubdir.Rd b/man/createRootSubdir.Rd index bf680f5..8a6e903 100644 --- a/man/createRootSubdir.Rd +++ b/man/createRootSubdir.Rd @@ -11,3 +11,4 @@ createRootSubdir(...) Helper function to silently create a subdirectory in the parent project directory (the processed data directory). } + diff --git a/man/dirData.Rd b/man/dirData.Rd index 97d8431..c7d4a6d 100644 --- a/man/dirData.Rd +++ b/man/dirData.Rd @@ -11,3 +11,4 @@ dirData(...) Data Dir Helper wrapper to get data for this project. } + diff --git a/man/dirOut.Rd b/man/dirOut.Rd index 9dbe40a..6578422 100644 --- a/man/dirOut.Rd +++ b/man/dirOut.Rd @@ -13,3 +13,4 @@ directory, instead of relative to the local directory. This allows you to keep a working directory that's relative to your code, but put the results somewhere else (such as a shared results space). } + diff --git a/man/dirRaw.Rd b/man/dirRaw.Rd index 9c76d6a..9616b19 100644 --- a/man/dirRaw.Rd +++ b/man/dirRaw.Rd @@ -11,3 +11,4 @@ dirRaw(...) Raw Data Dir Helper wrapper to get data for this project. } + diff --git a/man/dirRes.Rd b/man/dirRes.Rd index 8a5e41a..47ffaad 100644 --- a/man/dirRes.Rd +++ b/man/dirRes.Rd @@ -11,3 +11,4 @@ dirRes(...) Resource Dir Helper wrapper to get data for this project. } + diff --git a/man/dirWeb.Rd b/man/dirWeb.Rd index b6d8241..a00ec7c 100644 --- a/man/dirWeb.Rd +++ b/man/dirWeb.Rd @@ -11,3 +11,4 @@ dirWeb(...) Web Dir Helper wrapper to get data for this project. } + diff --git a/man/dirWrap.Rd b/man/dirWrap.Rd index 6895e38..444760f 100644 --- a/man/dirWrap.Rd +++ b/man/dirWrap.Rd @@ -11,3 +11,4 @@ dirWrap(var, ..., sub = NULL) Generic function to prepend an environment variable directory to your relative filepath. } + diff --git a/man/eload.Rd b/man/eload.Rd new file mode 100644 index 0000000..43f78a8 --- /dev/null +++ b/man/eload.Rd @@ -0,0 +1,12 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/projectInit.R +\name{eload} +\alias{eload} +\title{An exportable function} +\usage{ +eload(loadDat, loadEnvir = "SV") +} +\description{ +An exportable function +} + diff --git a/man/findConfigFile.Rd b/man/findConfigFile.Rd index dfa5c32..a7d3f54 100644 --- a/man/findConfigFile.Rd +++ b/man/findConfigFile.Rd @@ -27,3 +27,4 @@ for files with suitable config-like default names. It also allows a \code{projectName} with which to create another high-priority filename to look for. } + diff --git a/man/firstFile.Rd b/man/firstFile.Rd index d50a3a1..28d3f1d 100644 --- a/man/firstFile.Rd +++ b/man/firstFile.Rd @@ -19,3 +19,4 @@ firstFile(files, modify = identity) \code{firstFile} examines the filesystem and selects the first file from the given sequence that exists on it. } + diff --git a/man/go.Rd b/man/go.Rd index 235b185..789c90c 100644 --- a/man/go.Rd +++ b/man/go.Rd @@ -10,3 +10,4 @@ go(codeRoot = NULL, dataDir = NULL, outputSubdir = NULL, \description{ Make a secret alias function so I don't have to type so much } + diff --git a/man/penv.Rd b/man/penv.Rd index b467e23..ec57314 100644 --- a/man/penv.Rd +++ b/man/penv.Rd @@ -9,3 +9,4 @@ penv() \description{ Displays the environment variables that are set and used by this package. } + diff --git a/man/project.init.Rd b/man/project.init.Rd index fee32df..2b3d5da 100644 --- a/man/project.init.Rd +++ b/man/project.init.Rd @@ -10,3 +10,4 @@ project.init(codeRoot = NULL, dataDir = NULL, outputSubdir = NULL, \description{ Alias for backward compatibility } + diff --git a/man/project.init2.Rd b/man/project.init2.Rd index 0d23e17..c8d7361 100644 --- a/man/project.init2.Rd +++ b/man/project.init2.Rd @@ -10,3 +10,4 @@ project.init2(codeRoot = NULL, dataDir = NULL, outputSubdir = NULL, \description{ Alias for backward compatibility } + diff --git a/man/projectInit.Rd b/man/projectInit.Rd index c28d451..eb1c69d 100644 --- a/man/projectInit.Rd +++ b/man/projectInit.Rd @@ -4,7 +4,6 @@ \name{projectInit} \alias{projectInit} \alias{projectInit-package} -\alias{projectInit} \title{Package docs} \usage{ projectInit(codeRoot = NULL, dataDir = NULL, outputSubdir = NULL, @@ -30,9 +29,10 @@ Package docs \code{projectInit} sources the \code{00-init.R} or \code{projectInit.R} script for the project. You pass a complete folder or a relative path. } -\references{ -\url{http://github.com/databio/projectInit} -} \author{ Nathan Sheffield } +\references{ +\url{http://github.com/databio/projectInit} +} + diff --git a/man/projectRefresh.Rd b/man/projectRefresh.Rd index d5bf8e6..01a4ce1 100644 --- a/man/projectRefresh.Rd +++ b/man/projectRefresh.Rd @@ -9,3 +9,4 @@ projectRefresh() \description{ Helper alias to re-run init script, using your current dir settings. } + diff --git a/man/refreshPackage.Rd b/man/refreshPackage.Rd index 9e34916..e496922 100644 --- a/man/refreshPackage.Rd +++ b/man/refreshPackage.Rd @@ -25,3 +25,4 @@ Detach a custom packages, re-document, re-install, and re-load. Useful if I'm debugging packages and want to try the new version. Expects it to be in the ${CODE} folder by default } + diff --git a/man/rp.Rd b/man/rp.Rd index 3ab2f3a..282b9f0 100644 --- a/man/rp.Rd +++ b/man/rp.Rd @@ -9,3 +9,4 @@ rp() \description{ Alias } + diff --git a/man/setOutputSubdir.Rd b/man/setOutputSubdir.Rd index 308f18a..c7d216f 100644 --- a/man/setOutputSubdir.Rd +++ b/man/setOutputSubdir.Rd @@ -9,3 +9,4 @@ setOutputSubdir(...) \description{ Creates and sets outputSubdir } +