Support seed in jitterdodge.

future_changes.md

@@ -5,4 +5,4 @@
 ### Changed
 
 ### Fixed
-- Jitter reproducibility in geom_jitter [[#911](https://github.com/JetBrains/lets-plot/issues/911)].
+- Jitter reproducibility in geom_jitter, position_jitter, position_jitterdodge [[#911](https://github.com/JetBrains/lets-plot/issues/911)].

plot-base/src/commonMain/kotlin/org/jetbrains/letsPlot/core/plot/base/pos/JitterDodgePos.kt

@@ -11,13 +11,20 @@ import org.jetbrains.letsPlot.core.plot.base.DataPointAesthetics
 import org.jetbrains.letsPlot.core.plot.base.GeomContext
 import org.jetbrains.letsPlot.core.plot.base.PositionAdjustment
 
-class JitterDodgePos(aesthetics: Aesthetics, groupCount: Int, width: Double?, jitterWidth: Double?, jitterHeight: Double?) :
+class JitterDodgePos(
+ aesthetics: Aesthetics,
+ groupCount: Int,
+ width: Double?,
+ jitterWidth: Double?,
+ jitterHeight: Double?,
+ jitterSeed: Long? = null
+) :
  PositionAdjustment {
  private val myJitterPosHelper: PositionAdjustment
  private val myDodgePosHelper: PositionAdjustment
 
  init {
- myJitterPosHelper = JitterPos(jitterWidth, jitterHeight)
+ myJitterPosHelper = JitterPos(jitterWidth, jitterHeight, jitterSeed)
  myDodgePosHelper = DodgePos(aesthetics, groupCount, width)
  }
 

plot-base/src/commonMain/kotlin/org/jetbrains/letsPlot/core/plot/base/pos/JitterPos.kt

@@ -35,7 +35,6 @@ internal class JitterPos(width: Double?, height: Double?, seed: Long? = null) :
  }
 
  companion object {
-
  val DEF_JITTER_WIDTH = 0.4
  val DEF_JITTER_HEIGHT = 0.4
  }

plot-base/src/commonMain/kotlin/org/jetbrains/letsPlot/core/plot/base/pos/PositionAdjustments.kt

@@ -64,9 +64,10 @@ object PositionAdjustments {
  groupCount: Int,
  width: Double?,
  jitterWidth: Double?,
- jitterHeight: Double?
+ jitterHeight: Double?,
+ jitterSeed: Long?
  ): PositionAdjustment {
- return JitterDodgePos(aesthetics, groupCount, width, jitterWidth, jitterHeight)
+ return JitterDodgePos(aesthetics, groupCount, width, jitterWidth, jitterHeight, jitterSeed)
  }
 
  enum class Meta(private val handlesGroups: Boolean) {

plot-builder/src/commonMain/kotlin/org/jetbrains/letsPlot/core/plot/builder/assemble/PosProvider.kt

@@ -115,12 +115,19 @@ abstract class PosProvider {
  }
  */
 
- fun jitterDodge(width: Double?, jitterWidth: Double?, jitterHeight: Double?): PosProvider {
+ fun jitterDodge(width: Double?, jitterWidth: Double?, jitterHeight: Double?, jitterSeed: Long?): PosProvider {
  return object : PosProvider() {
  override fun createPos(ctx: PosProviderContext): PositionAdjustment {
  val aesthetics = ctx.aesthetics
  val groupCount = ctx.groupCount
- return PositionAdjustments.jitterDodge(aesthetics, groupCount, width, jitterWidth, jitterHeight)
+ return PositionAdjustments.jitterDodge(
+ aesthetics,
+ groupCount,
+ width,
+ jitterWidth,
+ jitterHeight,
+ jitterSeed
+ )
  }
 
  override fun handlesGroups(): Boolean {

plot-stem/src/commonMain/kotlin/org/jetbrains/letsPlot/core/spec/Option.kt

@@ -480,6 +480,7 @@ object Option {
  const val DODGE_WIDTH = "dodge_width"
  const val JITTER_WIDTH = "jitter_width"
  const val JITTER_HEIGHT = "jitter_height"
+ const val JITTER_SEED = "jitter_seed"
  }
 
  object Stack {

plot-stem/src/commonMain/kotlin/org/jetbrains/letsPlot/core/spec/PosProto.kt

@@ -48,7 +48,8 @@ internal object PosProto {
  JITTER_DODGE -> PosProvider.jitterDodge(
  opts.getDouble(Pos.JitterDodge.DODGE_WIDTH),
  opts.getDouble(Pos.JitterDodge.JITTER_WIDTH),
- opts.getDouble(Pos.JitterDodge.JITTER_HEIGHT)
+ opts.getDouble(Pos.JitterDodge.JITTER_HEIGHT),
+ opts.getLong(Pos.JitterDodge.JITTER_SEED)
  )
 
  else -> throw IllegalArgumentException("Unknown position adjustments name: '$posName'")

python-package/lets_plot/plot/pos.py

@@ -188,7 +188,7 @@ def position_nudge(x=None, y=None):
  return _pos('nudge', x=x, y=y)
 
 
-def position_jitterdodge(dodge_width=None, jitter_width=None, jitter_height=None):
+def position_jitterdodge(dodge_width=None, jitter_width=None, jitter_height=None, jitter_seed=None):
  """
  This is primarily used for aligning points generated through `geom_point()`
  with dodged boxplots (e.g., a `geom_boxplot()` with a fill aesthetic supplied).
@@ -207,6 +207,9 @@ def position_jitterdodge(dodge_width=None, jitter_width=None, jitter_height=None
  Jittering height.
  The value of `jitter_height` is relative and typically ranges between 0 and 0.5.
  Values that are greater than 0.5 lead to overlapping of the points.
+ jitter_seed : int
+ A random seed to make the jitter reproducible.
+ If None (the default value), the seed is initialised with a random value.
 
  Returns
  -------
@@ -235,10 +238,11 @@ def position_jitterdodge(dodge_width=None, jitter_width=None, jitter_height=None
  stat='boxplot') + \\
  geom_point(aes(x='c', y='x', color='c'), \\
  size=4, shape=21, fill='white',
- position=position_jitterdodge())
+ position=position_jitterdodge(jitter_seed=42))
 
  """
- return _pos('jitterdodge', dodge_width=dodge_width, jitter_width=jitter_width, jitter_height=jitter_height)
+ return _pos('jitterdodge', dodge_width=dodge_width, jitter_width=jitter_width, jitter_height=jitter_height,
+ jitter_seed=jitter_seed)
 
 
 def position_stack(vjust=None, mode=None):