Skip to content

Commit

Permalink
Update running.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LunaSare committed May 27, 2020
1 parent fb60e41 commit b99484c
Showing 1 changed file with 32 additions and 8 deletions.
40 changes: 32 additions & 8 deletions mds/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,44 @@

# Running physcraper

You can run `physcraper` directly from the terminal or using a Jupyter notebook.
The easiest way to run physcraper is using the command line tools. This way, you can directly specify arguments, and a config file will be written down for the sake of reproducibility.

You can find instructions on how to set this up in the section [installing physcraper](INSTALL.md).
As input, you will minimally need a study and tree ids from a tree uploaded to the Open Tree of Life website:

```
physcraper_run_py -s OPENTREE_STUDY_ID -t OPENTREE_TREE_ID -o OUTPUT_DIRECTORY_NAME/AND/OR/PATH
```

The easist way to start a physcraper run is using a tree uploaded to the Open Tree of Life Project,
and a single gene alignment for those taxa.
By using OpenTree data tips of your tree are already ampped to taxa.
If you do not specify an alignment, physcraper will try to get one of the gene alignments that generated the tree. Provide the gene alignment that you want to be updated using the `-a` command:

```
physcraper_run_py -s OPENTREE_STUDY_ID -t OPENTREE_TREE_ID -o OUTPUT/DIRECTORY/NAME/AND/OR/PATH -a PATH/TO/GENE/ALIGNMENT/NAME
```

You can also run `physcraper` from a file using python with the command:

```
python my_physcraper_run.py
```

Run it interactively with

```
python -i my_physcraper_run.py
```

There are several examples of this types of run on the next section.

Besides running `physcraper` directly from the terminal, you can also run it using a Jupyter notebook.

<!--You can find instructions on how to set a Jupyter notebook up in the section [installing physcraper](INSTALL.md).-->

There is an example of a physcraper run based on data in OpenTree in docs/examples/data_scrape.py

Default physcraper runs use the OpenTree and NCBI web services, and are slow.
They are best run on a server or a desktop.

If you want to use a tree that is not available on OpenTree, you will need to provide a table linking the labels in your alignment and phylogeny to taxon names.

[Previous: Installation](INSTALL.md)

If you want to use a tree that is not available on OpenTree, you will need to provide a table linking the
labels in your alignemnt and phylogeny to taxon names.
[Next: Example runs](examples.md)

0 comments on commit b99484c

Please sign in to comment.