Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JVM metrics and plotting requests #15

Merged
merged 14 commits into from
Oct 15, 2024
Merged

Add JVM metrics and plotting requests #15

merged 14 commits into from
Oct 15, 2024

Conversation

btmonier
Copy link
Member

  • Added new parameter to plotHaploCounts():
    • geom
    • allows user to specify a given geometry (line, bar, or point)
  • Added new conditionals for to buildHaplotypeGraph():
    • Checks to see if the JVM is initialized. If not, it will cause an exception
      and direct user to run initPhg()
  • Added new class JvmStats:
    • Returns internal Java and PHG versions and memory information for JVM
      session
    • Can be instantiated using the jvmStats() constructor function
  • Added new checks for initPhg()
  • Added new parameters to plotGvcf() function:
    • colorOverride: Overrides bar color based on given user defined color
    • sampleOrder: Overrides default bar ordering based on user defined
      character vector

@btmonier btmonier self-assigned this Oct 11, 2024
@btmonier btmonier added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 11, 2024

# Get memory profile
runtime <- rJava::.jcall("java/lang/Runtime", "Ljava/lang/Runtime;", "getRuntime")
gbConv <- 1024 ^ 3
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to just not make 1073741824 the constant?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope - just easier to remember $1024^{3}$ when I was coding this and forgot to update! Updated.

Since we need to construct an interface to a local instance of Java, errors
may arise due to several issues. Two common causes are version issues and
memory allocated to the JVM. For debugging and monitoring purposes, we can
use the `jvmStats()` function which create a instance of a `JvmStats` object.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be "which creates". (add "s" to create)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated grammar

@btmonier btmonier merged commit 7218d44 into main Oct 15, 2024
4 checks passed
@btmonier btmonier deleted the jvm-enhancement branch October 16, 2024 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants