Data

Tools

Indexes

Applications

Experiments

Open Source Science

githubprocedureslab

Code Management Guidelines: R and GitHub Starter Kit for New Team Members

https://github.com/stringhinilab/githubprocedureslab

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.5%) to scientific vocabulary

Keywords

code-management data-management data-science-projects git github manual research research-team researchers rse rstats
Last synced: 4 months ago · JSON representation ·

Repository

Code Management Guidelines: R and GitHub Starter Kit for New Team Members

Basic Info
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 2
  • Open Issues: 2
  • Releases: 0
Topics
code-management data-management data-science-projects git github manual research research-team researchers rse rstats
Created about 1 year ago · Last pushed 10 months ago
Metadata Files
Readme License Code of conduct Citation

README.html 










readme






























Code and Data Lab Management Guidelines:  R and GitHub Starter Kit for New Team Members


License: CC BY-NC 4.0 DOI pages-build-deployment




Description


This book aims to provide a basic usage guide for new lab members regarding the handling of data and code with R and GitHub platform.


It provides: - A series of steps for onboarding. - Instructions on programs to install. - A guide to starting a project. - Recommendations on best practices. - Instructions on how to push locally created code to GitHub using RStudio.






Installation and Setup


Follow these steps only in case you want to edit the book:


    

  1. Clone the repository:
    2. 



git clone git@github.com:StringhiniLab/GitHubProceduresLab.git


    

  1. Install dependencies using renv:
    2. 



install.packages("renv")
renv::restore()


    

  1. Open the project in RStudio and compile the book running:
    2. 



quarto render






Contact


If you have any questions or suggestions, please contact open a GitHub issue.






Code of Conduct


Please note that the github_procedures project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.






Inspired? Cite Us!


If you use this book, please cite it as follows:


D’Andrea, F., & Stringhini, S. GitHub Lab Procedures: Onboarding Guide for New Lab Members [Computer software]. https://github.com/StringhiniLab/GitHubProceduresLab. https://doi.org/10.5281/zenodo.14510774






Session Info


The current environment setup is managed using renv to ensure reproducibility. The session info is as follows:


R version 4.2.1 (2022-06-23)
Platform: aarch64-apple-darwin20 (64-bit)
Running under: macOS Monterey 12.5

Matrix products: default
LAPACK: /Library/Frameworks/R.framework/Versions/4.2-arm64/Resources/lib/libRlapack.dylib

locale:
[1] en_US.UTF-8/en_US.UTF-8/en_US.UTF-8/C/en_US.UTF-8/en_US.UTF-8

attached base packages:
[1] stats     graphics  grDevices datasets  utils     methods   base     

other attached packages:
[1] usethis_3.1.0

loaded via a namespace (and not attached):
 [1] fansi_1.0.6       withr_3.0.2       rprojroot_2.0.4   utf8_1.2.4       
 [5] lifecycle_1.0.4   magrittr_2.0.3    pillar_1.9.0      rlang_1.1.4      
 [9] cli_3.6.3         renv_1.0.3        rstudioapi_0.17.1 fs_1.6.5         
[13] whisker_0.4.1     vctrs_0.6.5       tools_4.2.1       glue_1.8.0       
[17] purrr_1.0.2       compiler_4.2.1    pkgconfig_2.0.3   clipr_0.8.0      
[21] tibble_3.2.1

Owner

  • Name: StringhiniLab
  • Login: StringhiniLab
  • Kind: organization

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: >-
  Code Management Guidelines: R and GitHub Starter Kit for New Team Members
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Florencia
    family-names: D'Andrea
    email: florencia.dandrea@ubc.ca
    affiliation: University of British Columbia
    orcid: 'https://orcid.org/0000-0002-0041-097X'
  - given-names: Silvia
    family-names: Stringhini
    email: silvia.stringhini@ubc.ca
    affiliation: University of British Columbia
    orcid: 'https://orcid.org/0000-0002-4387-8943'
identifiers:
  - type: doi
    value: 10.5281/zenodo.14510774
repository-code: 'https://github.com/StringhiniLab/GitHubProceduresLab'
url: 'https://stringhinilab.github.io/GitHubProceduresLab/'
abstract: >-
  A set of guidelines to essential R programming and GitHub usage
  for efficient code management.
keywords:
  - Quarto
  - Onboarding
  - Research Data Managment
  - GitHub
  - R
  - Research Code Managment
license: CC-BY-NC-4.0

GitHub Events

Total
  • Create event: 5
  • Issues event: 1
  • Release event: 3
  • Issue comment event: 2
  • Member event: 1
  • Push event: 39
  • Pull request event: 1
Last Year
  • Create event: 5
  • Issues event: 1
  • Release event: 3
  • Issue comment event: 2
  • Member event: 1
  • Push event: 39
  • Pull request event: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 1
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • flor14 (1)
Pull Request Authors
  • richfitz (1)
Top Labels
Issue Labels
Pull Request Labels