# bioproject

**Repository Path**: mselab_admin_1/bioproject

## Basic Information

- **Project Name**: bioproject
- **Description**: Bioproject可用来实现对本地分析项目中关键文件的git管理。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-06
- **Last Updated**: 2026-09-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# BioProject - 生物信息学项目管理工具

一个专门为生物信息学研究和数据分析设计的项目目录管理工具，支持Git版本控制和Gitee远程仓库同步。

## 功能特性

- 🔧 **自动初始化**: 创建标准化的生物信息学项目目录结构
- 📁 **智能文件管理**: 自动跟踪重要文件，忽略大型数据文件
- 🔄 **版本控制**: 基于Git的版本控制系统
- ☁️ **云端备份**: 自动同步到Gitee远程仓库
- 📊 **项目快照**: 一键创建项目状态快照

## 安装

1. 克隆或下载此项目到本地
2. 确保系统已安装Python 3.6+和Git
3. 给脚本添加执行权限：

```bash
chmod +x bioproject
```

4. (可选) 将bioproject添加到PATH环境变量中，以便全局使用

## 使用方法

### 1. 初始化新项目

```bash
# 基本初始化
./bioproject init MyProject --desc "我的生物信息学分析项目"

# 同时配置Gitee远程仓库
./bioproject init MyProject --repo https://gitee.com/username/myproject.git --desc "我的生物信息学分析项目"
```

执行后会创建以下目录结构：

```
MyProject/
├── scripts/          # 分析脚本 (Python, Shell, R等)
├── data/            # 数据目录
│   ├── raw/         # 原始数据 (不纳入版本控制)
│   └── processed/   # 处理后的数据
├── results/         # 分析结果
├── docs/           # 文档
├── config/         # 配置文件
├── .bioproject.json  # 项目配置
├── .gitignore      # Git忽略文件配置
└── README.md       # 项目说明
```

### 2. 创建项目快照

在项目目录中执行：

```bash
# 创建快照（自动生成提交信息）
./bioproject snapshot

# 创建快照并添加自定义提交信息
./bioproject snapshot -m "完成数据预处理脚本"
```

### 3. 查看项目状态

```bash
./bioproject status
```

### 4. 添加远程仓库

如果初始化时没有配置远程仓库，可以后续添加：

```bash
./bioproject remote https://gitee.com/username/myproject.git
```

## 自动跟踪的文件类型

BioProject会自动跟踪以下类型的文件：

- **脚本文件**: `*.py`, `*.sh`, `*.R`
- **文档文件**: `*.md`, `*.txt`
- **配置文件**: `*.yml`, `*.yaml`, `*.json`, `Makefile`, `requirements.txt`, `environment.yml`
- **小型数据文件**: `*.csv` (小于100MB)

## 自动忽略的文件类型

为了避免版本控制系统被大型文件拖慢，以下文件类型会被自动忽略：

- **大型生物数据**: `*.bam`, `*.sam`, `*.fastq`, `*.fq`, `*.fa`, `*.fasta`
- **压缩文件**: `*.gz`, `*.zip`, `*.tar`, `*.tar.gz`
- **临时文件**: `*.log`, `*.tmp`, `*.temp`
- **Python缓存**: `__pycache__/`, `*.pyc`, `*.pyo`
- **环境目录**: `env/`, `venv/`, `.venv`
- **原始数据目录**: `data/raw/`, `data/temp/`, `results/temp/`

## 典型工作流程

1. **项目初始化**:
   ```bash
   ./bioproject init RNA-seq-analysis --repo https://gitee.com/mylab/rna-seq.git
   cd RNA-seq-analysis
   ```

2. **开发分析脚本**:
   ```bash
   # 在scripts/目录下编写Python或Shell脚本
   vim scripts/preprocess.py
   vim scripts/differential_analysis.R
   ```

3. **创建快照**:
   ```bash
   ./bioproject snapshot -m "添加数据预处理脚本"
   ```

4. **继续开发和创建快照**:
   ```bash
   # 继续开发...
   ./bioproject snapshot -m "完成差异表达分析"
   ```

5. **查看项目状态**:
   ```bash
   ./bioproject status
   ```

## 配置文件说明

`.bioproject.json` 文件包含项目配置信息：

```json
{
  "project_name": "项目名称",
  "description": "项目描述",
  "created_at": "创建时间",
  "gitee_repo": "远程仓库地址",
  "tracked_patterns": ["跟踪的文件模式"],
  "ignore_patterns": ["忽略的文件模式"]
}
```

## 注意事项

1. 确保在使用前已安装Git并配置好用户信息
2. 原始数据文件建议放在 `data/raw/` 目录，该目录不会被Git跟踪
3. 大型结果文件建议放在 `results/temp/` 目录或使用其他云存储方案
4. 定期使用 `snapshot` 命令创建项目快照，确保重要工作不丢失

## 高级用法

#### 集成到现有项目：
```bash
# 在现有项目目录中初始化
cd existing_project
/path/to/bioproject init "existing_project" --desc "现有项目的版本控制"
```

这样，BioProject将帮助您高效地管理生物信息学分析项目，确保重要的脚本和配置文件得到妥善的版本控制和备份。

## 许可证

MIT License

## 贡献

欢迎提交Issue和Pull Request！