Skip to content

Commit

Permalink
docs: add example initialization
Browse files Browse the repository at this point in the history
  • Loading branch information
jjjermiah committed Feb 4, 2024
1 parent 26092e0 commit 1f242d5
Showing 1 changed file with 36 additions and 31 deletions.
67 changes: 36 additions & 31 deletions docs/test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ initialize the client when performing a query.

.. tabs::

.. tab:: Command Line
.. tab::




To perform an operation using the command line, use the following command:

.. code-block:: bash

your_command_line_tool --option1 value1 --option2 value2

.. tab:: Python

Expand All @@ -27,49 +27,61 @@ initialize the client when performing a query.
instance.run_operation()
.. tabs::

.. tab:: Apples
To get a list of available public collections that start with "TCGA", run the following command:

Apples are green, or sometimes red.
.. tab:: Command Line

.. tab:: Pears
.. tabs::

Pears are green.
.. tab:: Guest Account

.. tab:: Oranges
.. code-block:: bash
Oranges are orange.
getCollections --prefix TCGA
.. tabs::
.. tab:: Your Account

getCollections -u <USERNAME> -p <PASSWORD> --prefix TCGA

.. tab:: Stars
.. tab:: Python

.. tabs::

.. tab:: The Sun
.. tab:: Guest Account

The closest star to us.
.. code-block:: python
.. tab:: Proxima Centauri
from nbiatoolkit import NBIAClient
The second closest star to us.
client = NBIAClient()
client.getCollections(prefix='TCGA')
.. tab:: Polaris
.. tab:: Your Account

The North Star.
.. code-block:: python
.. tab:: Moons
from nbiatoolkit import NBIAClient
.. tabs::
client = NBIAClient(username = "<USERNAME>", password = "<PASSWORD>")
client.getCollections(prefix='TCGA')
.. tab:: The Moon
.. tabs::

.. tab:: Apples

Apples are green, or sometimes red.

.. tab:: Pears

Orbits the Earth
Pears are green.

.. tab:: Oranges

.. tab:: Titan
Oranges are orange.

Orbits Jupiter

.. tabs::

Expand Down Expand Up @@ -171,10 +183,3 @@ initialize the client when performing a query.
main <- function() {
return(0)
}
Configuration
-------------

Your configuration details go here.

...

0 comments on commit 1f242d5

Please sign in to comment.