Skip to content

Commit

Permalink
broken link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
espinoj committed Feb 23, 2024
1 parent 574b868 commit 474c946
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/causal-cmd/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ <h2 id="introduction">Introduction</h2>
<p>Causal discovery algorithms allow a user to uncover the causal relationships between variables in a dataset. These discovered causal relationships may be used further--understanding the underlying the processes of a system (e.g., the metabolic pathways of an organism), hypothesis generation (e.g., variables that best explain an outcome), guide experimentation (e.g., what gene knockout experiments should be performed) or prediction (e.g. parameterization of the causal graph using data and then using it as a classifier).</p>
<h2 id="command-line-usage">Command Line Usage</h2>
<p>Java 8 or higher is the only prerequisite to run the software. Note that by default Java will allocate the smaller of 1/4 system memory or 1GB to the Java virtual machine (JVM). If you run out of memory (heap memory space) running your analyses you should increase the memory allocated to the JVM with the following switch '-XmxXXG' where XX is the number of gigabytes of ram you allow the JVM to utilize. For example to allocate 8 gigabytes of ram you would add -Xmx8G immediately after the java command.</p>
<p>In this example, we'll use download the <a href="http://www.ccd.pitt.edu/wp-content/uploads/files/Retention.txt">Retention.txt</a> file, which is a dataset containing information on college graduation and used in the publication of "What Do College Ranking Data Tell Us About Student Retention?" by Drudzel and Glymour, 1994.</p>
<p>Keep in mind that causal-cmd has different switches for different algorithms. To start, type the following command in your terminal:</p>
<p>In this example, we'll use download the <a href="https://raw.githubusercontent.com/bd2kccd/causal-cmd/development/dist/Retention.txt">Retention.txt</a>
Keep in mind that causal-cmd has different switches for different algorithms. To start, type the following command in your terminal:</p>
<pre><code>java -jar causal-cmd-&lt;version number&gt;-jar-with-dependencies.jar
</code></pre>
<p>** Note: we are using <code>causal-cmd-&lt;version number&gt;-jar-with-dependencies.jar</code> to indicate the actual executable jar of specific version number that is being used. **</p>
Expand Down Expand Up @@ -206,7 +206,7 @@ <h2 id="command-line-usage">Command Line Usage</h2>
--timeLag &lt;integer&gt; A time lag for time series data, automatically applied (zero if none)
--verbose Yes if verbose output should be printed or logged
</code></pre>
<p>In this example, we'll be running the FGES algorith on the dataset <code>Retention.txt</code>.</p>
<p>In this example, we'll be running the FGES algorithm on the dataset <code>Retention.txt</code>.</p>
<pre><code class="language-bash">$ java -jar causal-cmd-1.10.0-jar-with-dependencies.jar --algorithm fges --data-type continuous --dataset Retention.txt --delimiter tab --score sem-bic-score
</code></pre>
<p>This command will output by default one file fges_&lt;unix timestamp&gt;.txt which is a log and result of the algorithm's activity.<br />
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -205,5 +205,5 @@ <h2 id="tools-and-software">Tools and Software</h2>

<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-02-23 04:41:39.737145+00:00
Build Date UTC : 2024-02-23 04:48:08.515470+00:00
-->
2 changes: 1 addition & 1 deletion docs/py-causal/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ <h2 id="running-jupyteripython">Running Jupyter/IPython</h2>
<h1 id="anacondajupyter">Anaconda/Jupyter</h1>
<p>Installing Python with Anaconda and Jupyter may be easier for some users:</p>
<ul>
<li><a href="https://www.continuum.io/downloads">Download and install Anaconda</a></li>
<li><a href="https://www.anaconda.com/">Download and install Anaconda</a></li>
<li>conda install python-javabridge</li>
</ul>
<p>For OS X, this default install does not seem to work well. try the following instead:</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/search/search_index.json

Large diffs are not rendered by default.

Binary file modified docs/sitemap.xml.gz
Binary file not shown.
5 changes: 2 additions & 3 deletions docs_src/causal-cmd.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ Causal discovery algorithms allow a user to uncover the causal relationships bet

Java 8 or higher is the only prerequisite to run the software. Note that by default Java will allocate the smaller of 1/4 system memory or 1GB to the Java virtual machine (JVM). If you run out of memory (heap memory space) running your analyses you should increase the memory allocated to the JVM with the following switch '-XmxXXG' where XX is the number of gigabytes of ram you allow the JVM to utilize. For example to allocate 8 gigabytes of ram you would add -Xmx8G immediately after the java command.

In this example, we'll use download the [Retention.txt](http://www.ccd.pitt.edu/wp-content/uploads/files/Retention.txt) file, which is a dataset containing information on college graduation and used in the publication of "What Do College Ranking Data Tell Us About Student Retention?" by Drudzel and Glymour, 1994.

In this example, we'll use download the [Retention.txt](https://raw.githubusercontent.com/bd2kccd/causal-cmd/development/dist/Retention.txt)
Keep in mind that causal-cmd has different switches for different algorithms. To start, type the following command in your terminal:

````
Expand Down Expand Up @@ -103,7 +102,7 @@ usage: java -jar Causal-cmd Project-1.10.0.jar --algorithm fges --data-type cont
--verbose Yes if verbose output should be printed or logged
````

In this example, we'll be running the FGES algorith on the dataset `Retention.txt`.
In this example, we'll be running the FGES algorithm on the dataset `Retention.txt`.
````bash
$ java -jar causal-cmd-1.10.0-jar-with-dependencies.jar --algorithm fges --data-type continuous --dataset Retention.txt --delimiter tab --score sem-bic-score
Expand Down
2 changes: 1 addition & 1 deletion docs_src/py-causal.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Anaconda/Jupyter

Installing Python with Anaconda and Jupyter may be easier for some users:

* [Download and install Anaconda](https://www.continuum.io/downloads)
* [Download and install Anaconda](https://www.anaconda.com/)
* conda install python-javabridge

For OS X, this default install does not seem to work well. try the following instead:
Expand Down

0 comments on commit 474c946

Please sign in to comment.