Skip to content

Commit

Permalink
create_templates() should not default to user's home dir
Browse files Browse the repository at this point in the history
  • Loading branch information
davidski committed Apr 17, 2019
1 parent cbdb72c commit 0f2988d
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 7 deletions.
5 changes: 3 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# evaluator (development version)

* `summarize_to_disk()` no longer defaults to the user's home directory for
writing to disk. A path to place the summary files must be provided.
* `summarize_to_disk()` and `create_templates()` no longer default to the
user's home directory for writing to disk. A path to place the generated
files must be provided.

# evaluator 0.4.0

Expand Down
2 changes: 1 addition & 1 deletion R/load_data.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
#' \dontrun{
#' create_templates("~/evaluator")
#' }
create_templates <- function(base_directory = "~/evaluator"){
create_templates <- function(base_directory){

inputs_dir = file.path(base_directory, "inputs")
if (!dir.exists(inputs_dir)) dir.create(inputs_dir, recursive = TRUE)
Expand Down
2 changes: 1 addition & 1 deletion man/create_templates.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions vignettes/process.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ together represent an analysis snapshot.

## Quick Start Script

When using `create_templates()` an `run_analysis.R` file will be placed at the base
When using `create_templates()` a `run_analysis.R` file will be placed at the base
of the `evaluator` directory. A sample ultra-quick workflow looks like:

1. Run `evaluator::create_templates()`
1. Run `evaluator::create_templates("~/evaluator")`
2. Edit the inputs for your situation.
3. Run the quick start script with code like the following:

Expand Down
2 changes: 1 addition & 1 deletion vignettes/usage.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ demonstration model based upon the
[HITRUST CSF](https://hitrustalliance.net/hitrust-csf/).

To start a fresh analysis using the default starter files, run
`create_templates()`. This creates an `evaluator` directory in your home
`create_templates("~/evaulator")`. This creates an `evaluator` directory in your home
location with an `inputs` subdirectory containing a survey tool (Excel), a
comma-separated file defining the domains used in the survey tool, and a file
defining the risk tolerance levels for your organization.
Expand Down

0 comments on commit 0f2988d

Please sign in to comment.