Skip to content

Commit

Permalink
Merge pull request #264 from PGScatalog/docs_version
Browse files Browse the repository at this point in the history
Add information about versions
  • Loading branch information
smlmbrt authored Mar 19, 2024
2 parents 6ad412a + 9c3a8ac commit 6d02f21
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/how-to/change_version.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _version:

How do I change the version or update `pgsc_calc`?
==================================================

If you would like to use a specific version of `pgsc_calc` and are running
the pipeline using our Github repository you can use some of the default nextflow
parameters (see `-r command docs <https://www.nextflow.io/docs/latest/sharing.html#handling-revisions>`_).
To run a specific version:

.. code-block:: console
nextflow run pgscatalog/pgsc_calc -profile <docker/singularity/conda> -r [version name, e.g. v2.0.0-alpha.5] ....
To run the latest version of a previously cloned repository you can use `nextflow pull` or add the `-latest` flag to
a run command (see `nextflow docs <https://www.nextflow.io/docs/latest/cli.html#commands`_):

.. code-block:: console
nextflow run pgscatalog/pgsc_calc -profile <docker/singularity/conda> -latest ....
8 changes: 8 additions & 0 deletions docs/how-to/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,11 @@ Working with complex datasets

copygenomes
yaml

Other
-----

.. toctree::
:maxdepth: 1

version

0 comments on commit 6d02f21

Please sign in to comment.