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

Ensure viz passes the devtools check #50

Closed
Kdreval opened this issue Mar 16, 2024 · 1 comment · Fixed by #55
Closed

Ensure viz passes the devtools check #50

Kdreval opened this issue Mar 16, 2024 · 1 comment · Fixed by #55
Assignees
Labels
enhancement New feature or request

Comments

@Kdreval
Copy link
Contributor

Kdreval commented Mar 16, 2024

Self-explanatory

@Kdreval Kdreval self-assigned this Mar 16, 2024
@Kdreval Kdreval added the enhancement New feature or request label Mar 16, 2024
@Kdreval
Copy link
Contributor Author

Kdreval commented Mar 17, 2024

Current status indicates the issue that needs to be addressed:

❯ checking for code/documentation mismatches ... WARNING
  Codoc mismatches from documentation object 'heatmap_mutation_frequency_bin':
  heatmap_mutation_frequency_bin
    Code: function(regions_list = NULL, regions_bed = NULL,
                   these_samples_metadata = NULL, these_sample_ids =
                   NULL, this_seq_type = c("genome", "capture"),
                   maf_data, mut_freq_matrix, projection = "grch37",
                   region_padding = 1000, drop_unmutated = FALSE,
                   metadataColumns = c("pathology"), sortByColumns =
                   NULL, expressionColumns = NULL, orientation =
                   "sample_rows", skip_regions, only_regions,
                   customColours = NULL, naColour = "white",
                   backgroundColour = "grey90", slide_by = 100,
                   window_size = 500, min_count_per_bin = 0,
                   min_bin_recurrence = 5, min_mut_tumour = 0,
                   region_fontsize = 8, cluster_rows_heatmap = FALSE,
                   cluster_cols_heatmap = FALSE, show_gene_colours =
                   FALSE, label_regions_by = "name", label_regions_rotate
                   = 0, legend_row = 3, legend_col = 3, legend_direction
                   = "horizontal", legendFontSize = 10, legend_side =
                   "bottom", return_heatmap_obj = FALSE,
                   from_indexed_flatfile = TRUE, mode = "slms-3")
    Docs: function(regions_list = NULL, regions_bed = NULL,
                   these_samples_metadata = NULL, these_sample_ids =
                   NULL, this_seq_type = c("genome", "capture"),
                   maf_data, mut_freq_matrix, projection = "grch37",
                   region_padding = 1000, drop_unmutated = FALSE,
                   metadataColumns = c("pathology"), sortByColumns =
                   c("pathology"), expressionColumns = NULL, orientation
                   = "sample_rows", skip_regions, only_regions,
                   customColours = NULL, backgroundColour = "grey90",
                   slide_by = 100, window_size = 500, min_count_per_bin =
                   0, min_bin_recurrence = 5, min_mut_tumour = 0,
                   region_fontsize = 8, cluster_rows_heatmap = FALSE,
                   cluster_cols_heatmap = FALSE, show_gene_colours =
                   FALSE, label_regions_by = "name", label_regions_rotate
                   = 0, legend_row = 3, legend_col = 3, legend_direction
                   = "horizontal", legendFontSize = 10, legend_side =
                   "bottom", return_heatmap_obj = FALSE,
                   from_indexed_flatfile = TRUE, mode = "slms-3")
    Argument names in code not in docs:
      naColour
    Mismatches in argument names (first 3):
      Position: 18 Code: naColour Docs: backgroundColour
      Position: 19 Code: backgroundColour Docs: slide_by
      Position: 20 Code: slide_by Docs: window_size
    Mismatches in argument default values:
      Name: 'sortByColumns' Code: NULL Docs: c("pathology")

@Kdreval Kdreval linked a pull request Mar 17, 2024 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant