Add more parameters

Author: seisman

doc/api/index.rst

@@ -37,7 +37,6 @@ Plotting map elements
     Figure.timestamp
     Figure.vlines
 
-
 Plotting tabular data
 ~~~~~~~~~~~~~~~~~~~~~
 

pygmt/src/basemap.py

@@ -2,6 +2,8 @@
 basemap - Plot base maps and frames.
 """
 
+import warnings
+
 from pygmt.alias import Alias, AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
@@ -72,8 +74,9 @@ def basemap(self, projection=None, **kwargs):
         [Default is ``"4p/-4p"``] and shade sets the fill style to use for
         shading [Default is ``"gray50"``].
     rose : str
-        Draw a map directional rose on the map at the location defined by
-        the reference and anchor points.
+        Draw a map directional rose on the map.
+
+        Deprecated. Use :py:func:`pygmt.Figure.directional_rose` instead.
     compass : str
         Draw a map magnetic rose on the map at the location defined by the
         reference and anchor points.
@@ -87,5 +90,14 @@ def basemap(self, projection=None, **kwargs):
     aliasdict = AliasSystem(
         J=Alias(projection, name="projection"),
     ).merge(kwargs)
+
+    if aliasdict.get("Td"):
+        warnings.warn(
+            "Parameter 'rose' is deprecated and will be removed in a future version. "
+            "Use 'Figure.directional_rose' instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
     with Session() as lib:
         lib.call_module(module="basemap", args=build_arg_list(aliasdict))

pygmt/src/directional_rose.py

@@ -11,7 +11,7 @@
 from pygmt.helpers import build_arg_list
 
 
-def directional_rose(
+def directional_rose(  # noqa: PLR0913
     self,
     position,
     position_type: Literal[
@@ -22,6 +22,10 @@ def directional_rose(
     anchor_offset: Sequence[float | str] | None = None,
     label: Sequence[str] | bool = False,
     fancy: Literal[1, 2, 3] | bool = False,
+    box=None,
+    perspective=None,
+    verbose=None,
+    transparency=None,
 ):
     r"""
     Add a directional rose to the map.
@@ -81,6 +85,7 @@ def directional_rose(
     self._activate_figure()
 
     aliasdict = AliasSystem(
+        F=Alias(box, name="box"),
         Td=[
             Alias(
                 position_type,
@@ -99,7 +104,10 @@ def directional_rose(
             Alias(justify, name="justify", prefix="+j"),
             Alias(label, name="label", prefix="+l", sep=",", size=4),
             Alias(anchor_offset, name="anchor_offset", prefix="+o", sep="/", size=2),
-        ]
+        ],
+        V=Alias(verbose, name="verbose"),
+        p=Alias(perspective, name="perspective"),
+        t=Alias(transparency, name="transparency"),
     )
 
     with Session() as lib: