Science Score: 44.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
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (18.0%) to scientific vocabulary
Last synced: 8 months ago
·
JSON representation
·
Repository
:package: The Title of the Project
Basic Info
- Host: GitHub
- Owner: avallecam
- License: gpl-2.0
- Language: Lua
- Default Branch: main
- Size: 111 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Created over 2 years ago
· Last pushed over 2 years ago
Metadata Files
Readme
Contributing
License
Code of conduct
Citation
Support
README.Rmd
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%")
```
# projectname
[](https://choosealicense.com/licenses/gpl-2.0/)
[](#)
Research Compendium of the project to test how to make an open, reproducible, sustainable analysis project.
## How to cite
Please cite this compendium as:
```{r,echo=FALSE}
readCitationFile(file = "inst/CITATION")
```
## Content
This repository is structured as follow:
- [`data/`](https://github.com/avallecam/projectname/tree/master/data):
contains all raw data required to perform analyses
- [`analyses/`](https://github.com/avallecam/projectname/tree/main/analyses/):
contains R scripts to run each step of the workflow
- [`outputs/`](https://github.com/avallecam/projectname/tree/main/outputs):
contains all the results created during the workflow
- [`figures/`](https://github.com/avallecam/projectname/tree/main/figures):
contains all the figures created during the workflow
- [`R/`](https://github.com/avallecam/projectname/tree/main/R):
contains R functions developed especially for this project
- [`man/`](https://github.com/avallecam/projectname/tree/main/man):
contains help files of R functions
- [`DESCRIPTION`](https://github.com/avallecam/projectname/tree/main/DESCRIPTION):
contains project metadata (author, date, dependencies, etc.)
- [`make.R`](https://github.com/avallecam/projectname/tree/main/make.R):
main R script to run the entire project by calling each R script stored in the `analyses/` folder
## Usage
First, clone this repository. You can follow [steps on how to create a new Rstudio Project from a GitHub repository](https://happygitwithr.com/new-github-first.html#usethiscreate_from_github).
Then, run:
```{r eval = FALSE}
source("make.R")
```
### Notes
- All required packages, listed in the `DESCRIPTION` file, will be installed (if necessary)
- All required packages and R functions will be loaded
- Some analyses listed in the `make.R` might take time
## Licenses
**Text and figures :** [CC-BY-4.0](http://creativecommons.org/licenses/by/4.0/)
**Code :** See the [DESCRIPTION](DESCRIPTION) file
**Data :** [CC-0](http://creativecommons.org/publicdomain/zero/1.0/) attribution requested in reuse
## Contributing
Contributions are always welcome!
See our [contributing guide](/.github/CONTRIBUTING.md) for ways to get started.
Please adhere to this project's [Code of Conduct](/.github/CODE_OF_CONDUCT.md).
## Support
For support, please see our [Getting help guide](/.github/SUPPORT.md).
Owner
- Name: Andree Valle Campos
- Login: avallecam
- Kind: user
- Location: Lima, Perú
- Website: https://avallecam.github.io/
- Twitter: avallecam
- Repositories: 3
- Profile: https://github.com/avallecam
pron: él/he/his, peruano, tusán.
Citation (CITATION.cff)
# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.5.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
cff-version: 1.2.0
message: 'To cite package "projectname" in publications use:'
type: software
license: GPL-2.0-or-later
title: 'projectname: My Reproducible Project'
version: 0.0.0.9000
abstract: A paragraph providing a full description of the project (on several lines...)
authors:
- family-names: Valle-Campos
given-names: Andree
email: avallecam@gmail.com
orcid: https://orcid.org/0000-0002-7779-481X
preferred-citation:
type: generic
title: 'projectname: My Reproducible Project'
authors:
- family-names: Valle-Campos
given-names: Andree
email: avallecam@gmail.com
orcid: https://orcid.org/0000-0002-7779-481X
year: '2023'
url: https://github.com/avallecam/projectname
abstract: A paragraph providing a full description of the project (on several lines...)
version: 0.0.0.9000
repository-code: https://github.com/avallecam/projectname
url: https://github.com/avallecam/projectname
contact:
- family-names: Valle-Campos
given-names: Andree
email: avallecam@gmail.com
orcid: https://orcid.org/0000-0002-7779-481X
GitHub Events
Total
Last Year
Committers
Last synced: 10 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Andree Valle | a****m@g****m | 21 |
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Dependencies
DESCRIPTION
cran
- devtools * imports
- here * imports