From 66d50f11b5cbae2190902dcabb5e1195acec6423 Mon Sep 17 00:00:00 2001 From: alexanderbates Date: Wed, 24 Jul 2024 21:52:27 -0400 Subject: [PATCH] Updated documentation --- NAMESPACE | 1 + R/banc-table.R | 3 ++- man/banc_change_log.Rd | 2 +- man/banc_neuron_comparison_plot.Rd | 5 ++--- man/banctable_query.Rd | 5 ++++- 5 files changed, 10 insertions(+), 6 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 73e995a..7b15161 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -63,6 +63,7 @@ export(banc_vnc_side_view) export(banc_vnc_view) export(banc_voxdims) export(banc_xyz2id) +export(banctable_append_rows) export(banctable_login) export(banctable_query) export(banctable_set_token) diff --git a/R/banc-table.R b/R/banc-table.R index b13d93f..d628b0d 100644 --- a/R/banc-table.R +++ b/R/banc-table.R @@ -226,8 +226,9 @@ banctable_base_impl <- function (base_name = "banc_meta", #' @export #' @rdname banctable_query banctable_append_rows <- function (df, table, base = NULL, chunksize = 1000L, ...) { - if (is.character(base) || is.null(base)) + if (is.character(base) || is.null(base)){ base = banctable_base(base_name = base, table = table) + } nx = nrow(df) if (!isTRUE(nx > 0)) { warning("No rows to append in `df`!") diff --git a/man/banc_change_log.Rd b/man/banc_change_log.Rd index 588d0f4..453650b 100644 --- a/man/banc_change_log.Rd +++ b/man/banc_change_log.Rd @@ -33,7 +33,7 @@ Fetch change log information for one or more neurons } \details{ As of August 2021 this is a simple wrapper of -\code{fabseg::\link{flywire_change_log}}. For now the old (and less +\code{fafbseg::\link{flywire_change_log}}. For now the old (and less convenient format) available from the zetta API can be obtained with the private \code{bancr:::banc_change_log_zetta} function. } diff --git a/man/banc_neuron_comparison_plot.Rd b/man/banc_neuron_comparison_plot.Rd index d60376a..68c9622 100644 --- a/man/banc_neuron_comparison_plot.Rd +++ b/man/banc_neuron_comparison_plot.Rd @@ -5,7 +5,7 @@ \title{Compare two neurons from the BANC connectome dataset} \usage{ banc_neuron_comparison_plot( - neuron1, + neuron1 = NULL, neuron2 = NULL, neuron3 = NULL, neuron1.info = NULL, @@ -83,8 +83,7 @@ dna02 <- nat::nlapply(dna02,Rvcg::vcgQEdecim,percent = 0.1) # Make plot! banc_neuron_comparison_plot(dna01, dna02, neuron1.info = "DNa01", -neuron2.info = "DNa02", -filename = "neuron_comparison.png") +neuron2.info = "DNa02", filename = "neuron_comparison.png") } } diff --git a/man/banctable_query.Rd b/man/banctable_query.Rd index a3405ce..226c983 100644 --- a/man/banctable_query.Rd +++ b/man/banctable_query.Rd @@ -5,6 +5,7 @@ \alias{banctable_set_token} \alias{banctable_login} \alias{banctable_update_rows} +\alias{banctable_append_rows} \title{Read and write to the seatable for draft BANC annotations} \usage{ banctable_query( @@ -27,10 +28,12 @@ banctable_update_rows( df, table, base = NULL, - append_allowed = TRUE, + append_allowed = FALSE, chunksize = 1000L, ... ) + +banctable_append_rows(df, table, base = NULL, chunksize = 1000L, ...) } \arguments{ \item{sql}{A SQL query string. See examples and