data-raw/clss/C4_Ready4Project.R

#' Ready4Project
#'
#' A module of the ready4 framework that contains details of a modelling project.
#'
#' @include C4_Ready4Module.R
#' @slot ds_tb Dataset (a tibble)
#' @slot dictionary_r3 Dictionary (a ready4 submodule)
#' @slot dissemination_1L_chr Dissemination (a character vector of length one)
#' @name Ready4Project-class
#' @rdname Ready4Project-class
#' @export Ready4Project
#' @exportClass Ready4Project
Ready4Project <- setClass("Ready4Project",
                          contains = "Ready4Module",
                          slots = c(#additions_tb = "tbl_df",
                                    badges_url_1L_chr = "character",
                                    dv_nm_1L_chr = "character",
                                    dv_root_1L_chr = "character",
                                    dv_server_1L_chr = "character",
                                    dv_toy_data_1L_chr = "character",
                                    dvs_tb = "tbl_df",
                                    extensions_tb = "tbl_df",
                                    filter_cdns_ls = "list",
                                    gh_org_1L_chr = "character",
                                    gh_repo_1L_chr = "character",
                                    gh_repos_brochure_chr = "character",
                                    gh_repos_exclude_chr = "character",
                                    gh_repos_framework_chr ="character",
                                    gh_repos_model_chr = "character",
                                    gh_repos_programs_chr = "character",
                                    gh_repos_subroutines_chr = "character",
                                    gh_tag_1L_chr = "Documentation_0.0",
                                    gh_url_stub_1L_chr = "character",
                                    libraries_chr = "character",
                                    libraries_tb = "tbl_df",
                                    methods_tb = "tbl_df",
                                    modules_tb = "tbl_df",
                                    sections_chr = "character",
                                    url_for_prj_1L_chr = "character",
                                    zenodo_1L_chr = "character",
                                    dissemination_1L_chr = "character"),
                        prototype = list(#additions_tb = make_additions_tb(),
                                         badges_url_1L_chr = character(0),#project_badges_url_1L_chr = "https://img.shields.io/badge/ready4"
                                         dv_nm_1L_chr = character(0),#"ready4",
                                         dv_root_1L_chr = character(0),#"https://dataverse.harvard.edu/dataverse/",# root_1L_chr - print_data
                                         dv_server_1L_chr = "dataverse.harvard.edu", #server_1L_chr
                                         dv_toy_data_1L_chr = "fakes", #toy_data_dv_1L_chr =
                                         dvs_tb = ready4::get_datasets_tb()[0,],#NULL,
                                         extensions_tb = get_cls_extensions(get_libraries_tb())[0,],# cls_extensions_tb = get_cls_extensions(get_libraries_tb()) # NULL,
                                         filter_cdns_ls = list(),#NULL,
                                         gh_org_1L_chr = character(0), # org_1L_chr = "ready4-dev",
                                         gh_repo_1L_chr = character(0),#"ready4-dev/ready4",
                                         gh_repos_brochure_chr = character(0), # brochure_repos_chr =
                                         gh_repos_exclude_chr = character(0), #exclude_chr =
                                         gh_repos_framework_chr = character(0), # framework_repos_chr
                                         gh_repos_model_chr = character(0), # model_repos_chr
                                         gh_repos_programs_chr = character(0), # program_repos_chr
                                         gh_repos_subroutines_chr = character(0), # subroutine_repos_chr
                                         gh_tag_1L_chr = "Documentation_0.0",
                                         gh_url_stub_1L_chr = character(0), #url_stub_1L_chr = "https://ready4-dev.github.io/"
                                         libraries_chr = character(0), # module_pkgs_chr = make_modules_pkgs_chr() model_repos_chr = character(0),
                                         libraries_tb = make_libraries_tb(), #get_libraries_tb() # pkg_extensions_tb = NULL
                                         #methods_chr = NULL, # print_methods - Can be derived from included Ready4Module
                                         methods_tb = get_methods_tb(), #NULL, # print_methods
                                         modules_tb = get_modules_tb()[0,], #### print_modules
                                         sections_chr = character(0),
                                         url_for_prj_1L_chr = character(0),
                                         zenodo_1L_chr = "ready4"
                                         ))
ready4-dev/ready4 documentation built on Nov. 4, 2024, 11:38 p.m.