update documentation

Author: cwolfsonseeley

02-installation.Rmd

@@ -20,7 +20,7 @@ if (!dir.exists(package_dir)) dir.create(package_dir, recursive = TRUE)
 # then make a configuration file that notifies R of the new package directory
 # change [username] to your actual username in your P drive - usually your last name followed by your first initial
 if (!dir.exists(package_dir)) dir.create(package_dir, recursive = TRUE)
-env_file <- "\\ur2.urel.berkeley.edu\UR_USERS\[usernmae]"
+env_file <- "\\ur2.urel.berkeley.edu\UR_USERS\[username]"
 
 # and add the new location to the configuration file
 cat("\nR_LIBS_USER='", package_dir, "'",
@@ -50,13 +50,13 @@ If you haven't completed all of those items, head over to section [Test CDW](#te
 In order to make sure everything is working properly, we'll run a quick disco test:
 
 ```{r disco_test}
-# you'll always load the discoveryengine package before doing anythying else
+# you'll always load the discoveryengine package before doing anything else
 library(discoveryengine)
 # make sure we can create a disco definition
 high_cap = has_capacity(1)
 # make sure that things print properly
 high_cap
-# make sure we can send the defintion to the data warehouse
+# make sure we can send the definition to the data warehouse
 display(high_cap)
 ```
 

_main.tex

@@ -334,20 +334,20 @@ \chapter{Installation}\label{installation}}
 \end{Highlighting}
 \end{Shaded}
 
-The first result returned shoud be ``R:/Prospect Development/Prospect Analysis/pd-shared-r-packages''. If it's not, follow the steps below to change your default library path.
+The first result returned should be "\\\\ur2.urel.berkeley.edu/ur_unitshares/Prospect Development/Prospect Analysis/pd-shared-r-packages". If it's not, follow the steps below to change your default library path.
 
 Step 1: Open a new RStudio session and run the following script:
 
 \begin{Shaded}
 \begin{Highlighting}[]
 \CommentTok{# the first part sets up the new package directory}
-\NormalTok{package_dir <-}\StringTok{ "R:/Prospect Development/Prospect Analysis/pd-shared-r-packages"}
+\NormalTok{package_dir <-}\StringTok{ "\\\\ur2.urel.berkeley.edu/ur_unitshares/Prospect Development/Prospect Analysis/pd-shared-r-packages"}
 \ControlFlowTok{if}\NormalTok{ (}\OperatorTok{!}\KeywordTok{dir.exists}\NormalTok{(package_dir)) }\KeywordTok{dir.create}\NormalTok{(package_dir, }\DataTypeTok{recursive =} \OtherTok{TRUE}\NormalTok{)}
 
 \CommentTok{# then make a configuration file that notifies R of the new package directory}
-\CommentTok{# change [username] to your actual username in your P drive - usually LastNameFirstInitial}
-\NormalTok{env_file <-}\StringTok{ "P:/[username]/.Renviron"}
+\CommentTok{# change [username] to your actual username in your P drive - usually your last name followed by your first initial}
 \ControlFlowTok{if}\NormalTok{ (}\OperatorTok{!}\KeywordTok{file.exists}\NormalTok{(env_file)) }\KeywordTok{file.create}\NormalTok{(env_file)}
+\NormalTok{env_file <-}\StringTok{ "\\ur2.urel.berkeley.edu\UR_USERS\[username]"}
 
 \CommentTok{# and add the new location to the configuration file}
 \KeywordTok{cat}\NormalTok{(}\StringTok{"}\CharTok{\textbackslash{}n}\StringTok{R_LIBS_USER='"}\NormalTok{, package_dir, }\StringTok{"'"}\NormalTok{, }
@@ -357,14 +357,6 @@ \chapter{Installation}\label{installation}}
 
 Step 2:
 
-Find the newly created .Renviron file. It will be in your P drive.
-
-Step 3:
-
-Move the .Renviron file to your Documents folder. This should be located in D:\textbackslash Users\textbackslash{[}username{]}\textbackslash Documents. Simply drag and drop.
-
-Step 4:
-
 Quit your current RStudio session and open a new one. Try running the following test again:
 
 \begin{Shaded}
@@ -380,7 +372,6 @@ \section{Before you continue}\label{before-you-continue}}
 
 At this point, you should have already:
 - tested your CDW connection
-- installed \texttt{getcdw}
 - run a test query
 
 If you haven't completed all of those items, head over to section \protect\hyperlink{test-cdw}{Test CDW} and complete those steps, and then return here.
@@ -392,7 +383,7 @@ \section{A disco test}\label{a-disco-test}}
 
 \begin{Shaded}
 \begin{Highlighting}[]
-\CommentTok{# you'll always load the discoveryengine package before doing anythying else}
+\CommentTok{# you'll always load the discoveryengine package before doing anything else}
 \KeywordTok{library}\NormalTok{(discoveryengine)}
 \CommentTok{# make sure we can create a disco definition}
 \NormalTok{high_cap =}\StringTok{ }\KeywordTok{has_capacity}\NormalTok{(}\DecValTok{1}\NormalTok{)}
@@ -409,7 +400,7 @@ \section{A disco test}\label{a-disco-test}}
 
 \begin{Shaded}
 \begin{Highlighting}[]
-\CommentTok{# make sure we can send the defintion to the data warehouse}
+\CommentTok{# make sure we can send the definition to the data warehouse}
 \KeywordTok{display}\NormalTok{(high_cap)}
 \end{Highlighting}
 \end{Shaded}

docs/installation.html

@@ -283,25 +283,21 @@ <h1><span class="header-section-number">4</span> Installation</h1>
 <p>Discoveryengine (and all packages we use in Prospect Developmemt) is installed on the R drive. The most important step to make sure you can access these packages is to set up your default library path to the shared packages repository.</p>
 <p>Run a quick test to see your current library path:</p>
 <pre class="sourceCode r"><code class="sourceCode r"><span class="kw">.libPaths</span>()</code></pre>
-<p>The first result returned shoud be “R:/Prospect Development/Prospect Analysis/pd-shared-r-packages”. If it’s not, follow the steps below to change your default library path.</p>
+<p>The first result returned shoud be “\\\\ur2.urel.berkeley.edu/ur_unitshares/Prospect Development/Prospect Analysis/pd-shared-r-packages”. If it’s not, follow the steps below to change your default library path.</p>
 <p>Step 1: Open a new RStudio session and run the following script:</p>
 <pre class="sourceCode r"><code class="sourceCode r"><span class="co"># the first part sets up the new package directory</span>
-package_dir &lt;-<span class="st"> &quot;R:/Prospect Development/Prospect Analysis/pd-shared-r-packages&quot;</span>
+package_dir &lt;-<span class="st"> &quot;\\\\ur2.urel.berkeley.edu/ur_unitshares/Prospect Development/Prospect Analysis/pd-shared-r-packages&quot;</span>
 <span class="cf">if</span> (<span class="op">!</span><span class="kw">dir.exists</span>(package_dir)) <span class="kw">dir.create</span>(package_dir, <span class="dt">recursive =</span> <span class="ot">TRUE</span>)
 
 <span class="co"># then make a configuration file that notifies R of the new package directory</span>
-<span class="co"># change [username] to your actual username in your P drive - usually LastNameFirstInitial</span>
-env_file &lt;-<span class="st"> &quot;P:/[username]/.Renviron&quot;</span>
+<span class="co"># change [username] to your actual username in your P drive - usually your last name followed by your first initial</span>
 <span class="cf">if</span> (<span class="op">!</span><span class="kw">file.exists</span>(env_file)) <span class="kw">file.create</span>(env_file)
+env_file &lt;-<span class="st"> &quot;\\ur2.urel.berkeley.edu\UR_USERS\[username]&quot;</span>
 
 <span class="co"># and add the new location to the configuration file</span>
 <span class="kw">cat</span>(<span class="st">&quot;</span><span class="ch">\n</span><span class="st">R_LIBS_USER=&#39;&quot;</span>, package_dir, <span class="st">&quot;&#39;&quot;</span>, 
     <span class="dt">sep =</span> <span class="st">&quot;&quot;</span>, <span class="dt">file =</span> env_file, <span class="dt">append =</span> <span class="ot">TRUE</span>)</code></pre>
 <p>Step 2:</p>
-<p>Find the newly created .Renviron file. It will be in your P drive.</p>
-<p>Step 3:</p>
-<p>Move the .Renviron file to your Documents folder. This should be located in D:\Users\[username]\Documents. Simply drag and drop.</p>
-<p>Step 4:</p>
 <p>Quit your current RStudio session and open a new one. Try running the following test again:</p>
 <pre class="sourceCode r"><code class="sourceCode r"><span class="kw">.libPaths</span>()</code></pre>
 <p>If the PD shared packages depository is returned, you are ready to start using Disco Engine. If not, contact the Analytics Team to troubleshoot your situation.</p>