Skip to content

Commit

Permalink
capitalize the pipeline name, for consistency across the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vmikk committed Mar 12, 2024
1 parent 47cb64d commit a3a37e9
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,5 @@ For more details see [the Docker Desktop documentation](https://docs.docker.com/
## 3. Download the pipeline and test it on a minimal dataset with a single command

``` bash
nextflow run vmikk/phylonext -r main -profile test,docker
nextflow run vmikk/PhyloNext -r main -profile test,docker
```
14 changes: 7 additions & 7 deletions docs/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Spatial filters.

^3^:
PhyloNext ships [WGSRPD](https://www.tdwg.org/standards/wgsrpd/) shapefile as a built-in data.
To use it, specify a full path to the data (e.g., `$(realpath "${HOME}/.nextflow/assets/vmikk/phylonext/pipeline_data/WGSRPD.RData")`)
To use it, specify a full path to the data (e.g., `$(realpath "${HOME}/.nextflow/assets/vmikk/PhyloNext/pipeline_data/WGSRPD.RData")`)

^4^:
Multiple comma-separated values allowed.
Expand Down Expand Up @@ -264,11 +264,11 @@ in [`CoordinateCleaner`](https://ropensci.github.io/CoordinateCleaner/) R packag
PhyloNext provides files for removal of common spatial errors,
the data are built-in in the `pipeline_data` direcory and can be selected in the following way:
``` bash
--terrestrial `$(realpath "${HOME}/.nextflow/assets/vmikk/phylonext/pipeline_data/Land_Buffered_025_dgr.RData")`
--rmcountrycentroids `$(realpath "${HOME}/.nextflow/assets/vmikk/phylonext/pipeline_data/CC_CountryCentroids_buf_1000m.RData")`
--rmcountrycapitals `$(realpath "${HOME}/.nextflow/assets/vmikk/phylonext/pipeline_data/CC_Capitals_buf_10000m.RData")`
--rminstitutions `$(realpath "${HOME}/.nextflow/assets/vmikk/phylonext/pipeline_data/CC_Institutions_buf_100m.RData")`
--rmurban `$(realpath "${HOME}/.nextflow/assets/vmikk/phylonext/pipeline_data/CC_Urban.RData")`
--terrestrial `$(realpath "${HOME}/.nextflow/assets/vmikk/PhyloNext/pipeline_data/Land_Buffered_025_dgr.RData")`
--rmcountrycentroids `$(realpath "${HOME}/.nextflow/assets/vmikk/PhyloNext/pipeline_data/CC_CountryCentroids_buf_1000m.RData")`
--rmcountrycapitals `$(realpath "${HOME}/.nextflow/assets/vmikk/PhyloNext/pipeline_data/CC_Capitals_buf_10000m.RData")`
--rminstitutions `$(realpath "${HOME}/.nextflow/assets/vmikk/PhyloNext/pipeline_data/CC_Institutions_buf_100m.RData")`
--rmurban `$(realpath "${HOME}/.nextflow/assets/vmikk/PhyloNext/pipeline_data/CC_Urban.RData")`
```
Alternatively, users can provide own files with custom polygons.

Expand Down Expand Up @@ -330,7 +330,7 @@ The file comprises seven biogeographical kingdoms:

To activate spatially-constrained randomizations using these biogeographic regions, add the following argument to your command:
``` bash
--randconstrain `$(realpath "${HOME}/.nextflow/assets/vmikk/phylonext/pipeline_data/ZoogeographicRegions.gpkg")`
--randconstrain `$(realpath "${HOME}/.nextflow/assets/vmikk/PhyloNext/pipeline_data/ZoogeographicRegions.gpkg")`
```


Expand Down
13 changes: 12 additions & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,24 @@ See the `Configuration` section in the [usage documentation](https://phylonext.g

!!! failure "Pipeline revision version"
```
Project \`vmikk/phylonext\` is currently stickied on revision: main -- you need to explicitly specify a revision with the option \`-r\` in order to use it
Project \`vmikk/PhyloNext\` is currently stickied on revision: main -- you need to explicitly specify a revision with the option \`-r\` in order to use it
```

Solution - specify a version number of the pipeline.
To run the latest version, add `-r main` to your command.
Alternatively, you may specify the exact version (or tag) you wish, e.g. `-r v.0.0.2`.

###



process `get_ott_tree`
{
"message": "ERROR: no age estimate for subtree root could be found in datastore. Please re-run query with a max root age using argument 'max_age'\n"
}



## Installation problems

### Nextflow not found
Expand Down
24 changes: 12 additions & 12 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ description: >-

Test run the pipeline using test data and Docker engine:
``` bash
nextflow run vmikk/phylonext -r main -profile test,docker
nextflow run vmikk/PhyloNext -r main -profile test,docker
```

## Running the pipeline

The typical command for running the pipeline is as follows:

``` bash
nextflow run vmikk/phylonext -r main \
nextflow run vmikk/PhyloNext -r main \
--input "/mnt/GBIF/Parquet/2022-01-01/occurrence.parquet/" \
--classis "Mammalia" --family "Felidae,Canidae" \
--country "DE,PL,CZ" \
Expand Down Expand Up @@ -65,7 +65,7 @@ Without `-resume`, Nextflow will start the workflow from scratch and overwrite a
## Built-in data

PhyloNext pipeline contains several files for removing spatial outliers or data subsetting.
By default, built-in data is stored in the folder `${HOME}/.nextflow/assets/vmikk/phylonext/pipeline_data/`.
By default, built-in data is stored in the folder `${HOME}/.nextflow/assets/vmikk/PhyloNext/pipeline_data/`.

| File | Description | Citation |
| ------------------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
Expand All @@ -79,7 +79,7 @@ By default, built-in data is stored in the folder `${HOME}/.nextflow/assets/vmik

To use the built-in data, provide a full path to the data.
E.g., to remove records from urban areas, add the following parameter to your command:
`--rmurban ${HOME}/.nextflow/assets/vmikk/phylonext/pipeline_data/CC_Urban.RData`.
`--rmurban ${HOME}/.nextflow/assets/vmikk/PhyloNext/pipeline_data/CC_Urban.RData`.
Alternatively, you may use custom files prepared in the same format.

To remove common spatial errors from the data, PhyloNext uses databases
Expand Down Expand Up @@ -169,7 +169,7 @@ The total number of CPUs allowed to use by PhyloNext can be adjusted with `-qs`

To show a help message, run:
``` bash
nextflow run vmikk/phylonext -r main --help
nextflow run vmikk/PhyloNext -r main --help
```

## Configuration and profiles
Expand All @@ -181,7 +181,7 @@ such as parameter files, configuration files, and profiles.

As the number of parameters can be quite large, it is possible to pass the pipeline parameters via YAML or JSON file, e.g.:
``` bash
nextflow run vmikk/phylonext -r main -resume -params-file Mammals.yaml
nextflow run vmikk/PhyloNext -r main -resume -params-file Mammals.yaml
```

The YAML file could contain the following:
Expand Down Expand Up @@ -218,7 +218,7 @@ process {

Then, use the `-c` option to choose the created configuration file while running the pipeline. E.g.,
``` bash
nextflow run vmikk/phylonext ... -c my.config
nextflow run vmikk/PhyloNext ... -c my.config
```

!!! info "Configs"
Expand Down Expand Up @@ -264,13 +264,13 @@ Profiles are loaded in sequential order so that the later profile will overwrite
To make sure that you're running the latest version of the pipeline,
you may download the latest version and update the pipeline using:
``` bash
nextflow pull vmikk/phylonext
nextflow pull vmikk/PhyloNext
```
By default, the cached version of the pipeline is stored in the `~/.nextflow/assets/vmikk/PhyloNext` directory.

Run the latest development version of the pipeline (from the `main` branch of the code repository):
``` bash
nextflow run vmikk/phylonext -r main ...
nextflow run vmikk/PhyloNext -r main ...
```

When executing PhyloNext on your data, it is a good idea to specify a version number for the pipeline.
Expand All @@ -282,18 +282,18 @@ This version number will be recorded in pipeline reports so you can later go bac

Run the tagged version (e.g., v.1.3.0) of the pipeline:
``` bash
nextflow run vmikk/phylonext -r v.1.3.0 ...
nextflow run vmikk/PhyloNext -r v.1.3.0 ...
```

Print the pipeline and system runtime information:
``` bash
nextflow info
nextflow info vmikk/phylonext
nextflow info vmikk/PhyloNext
```

Delete the local copy of the pipeline:
``` bash
nextflow drop vmikk/phylonext
nextflow drop vmikk/PhyloNext
```

## Docker and Singularity containers
Expand Down

0 comments on commit a3a37e9

Please sign in to comment.